Trim some fat

Signed-off-by: Adam Warner <[email protected]>

README.md

@@ -19,41 +19,13 @@
 
 ## Quick Start
 
-1. Copy docker-compose.yml.example to docker-compose.yml and update as needed. See example below:
-[Docker-compose](https://docs.docker.com/compose/install/) example:
-
-```yaml
-version: "3"
-
-# More info at https://github.com/pi-hole/docker-pi-hole/ and https://docs.pi-hole.net/
-services:
-  pihole:
-    container_name: pihole
-    image: pihole/pihole:latest
-    # For DHCP it is recommended to remove these ports and instead add: network_mode: "host"
-    ports:
-      - "53:53/tcp"
-      - "53:53/udp"
-      - "67:67/udp" # Only required if you are using Pi-hole as your DHCP server
-      - "80:80/tcp"
-      - "443:443/tcp" # By default, FTL will generate a self-signed certificate
-    environment:
-      TZ: 'America/Chicago'
-      # FTLCONF_webserver_api_password: 'set a secure password here or it will be random'
-    # Volumes store your data between container upgrades
-    volumes:
-      - './etc-pihole:/etc/pihole'
-     # - './etc-dnsmasq.d:/etc/dnsmasq.d' # Only needed if you have some custom configs for dnsmasq
-    # https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
-    cap_add:
-      - NET_ADMIN # Required if you are using Pi-hole as your DHCP server, else not needed
-    restart: unless-stopped
-```
+Using [Docker-compose](https://docs.docker.com/compose/install/):
 
+1. Copy [the example docker compose file](/examples/docker-compose-example.yml) and update as needed
 2. Run `docker compose up -d` to build and start pi-hole (Syntax may be `docker-compose` on older systems)
 3. If using Docker's default `bridge` network setting, set the environment variable `FTLCONF_dns_listeningMode` to `all`
 
-[Here is an equivalent docker run script](https://github.com/pi-hole/docker-pi-hole/blob/master/examples/docker_run.sh).
+nb. Volumes are recommended for persisting data across container re-creations for updating images.
 
 ## Overview
 
@@ -65,18 +37,6 @@ A [Docker](https://www.docker.com/what-docker) project to make a lightweight x86
 
 [![Build Status](https://github.com/pi-hole/docker-pi-hole/workflows/Test%20&%20Build/badge.svg)](https://github.com/pi-hole/docker-pi-hole/actions?query=workflow%3A%22Test+%26+Build%22) [![Docker Stars](https://img.shields.io/docker/stars/pihole/pihole.svg?maxAge=604800)](https://store.docker.com/community/images/pihole/pihole) [![Docker Pulls](https://img.shields.io/docker/pulls/pihole/pihole.svg?maxAge=604800)](https://store.docker.com/community/images/pihole/pihole)
 
-## Running Pi-hole Docker
-
-This container uses 2 popular ports, port 53 and port 80, so **may conflict with existing applications ports**.  If you have no other services or docker containers using port 53/80 (if you do, keep reading below for a reverse proxy example), the minimum arguments required to run this container are in the script [docker_run.sh](https://github.com/pi-hole/docker-pi-hole/blob/master/examples/docker_run.sh)
-
-If you're using a Red Hat based distribution with an SELinux Enforcing policy add `:z` to line with volumes like so:
-
-```
-    -v "$(pwd)/etc-pihole:/etc/pihole:z" \
-```
-
-Volumes are recommended for persisting data across container re-creations for updating images.
-
 **Automatic Ad List Updates** - `cron` is baked into the container and will grab the newest versions of your lists and flush your logs. This happens once per week in the small hours of Sunday morning.
 
 ## Running DHCP from Docker Pi-Hole
@@ -139,9 +99,8 @@ Here is a rundown of other arguments for your docker-compose / docker run.
 - Port conflicts?  Stop your server's existing DNS / Web services.
   - Don't forget to stop your services from auto-starting again after you reboot
   - Ubuntu users see below for more detailed information
-- You can map other ports to Pi-hole port 80 using docker's port forwarding like this `-p 8080:80` if you are using the default blocking mode. If you are using the legacy IP blocking mode, you should not remap this port.
-  - [Here is an example of running with nginxproxy/nginx-proxy](https://github.com/pi-hole/docker-pi-hole/blob/master/examples/docker-compose-nginx-proxy.yml) (an nginx auto-configuring docker reverse proxy for docker) on my port 80 with Pi-hole on another port.  Pi-hole needs to be `DEFAULT_HOST` env in nginxproxy/nginx-proxy and you need to set the matching `VIRTUAL_HOST` for the Pi-hole's container.  Please read nginxproxy/nginx-proxy readme for more info if you have trouble.
 - Docker's default network mode `bridge` isolates the container from the host's network. This is a more secure setting, but requires setting the Pi-hole DNS option for _Interface listening behavior_ to "Listen on all interfaces, permit all origins".
+- If you're using a Red Hat based distribution with an SELinux Enforcing policy add `:z` to line with volumes
 
 ### Installing on Ubuntu or Fedora
 

examples/docker-compose-caddy-proxy.yml

@@ -22,7 +22,7 @@ services:
 
   # More info at https://github.com/pi-hole/docker-pi-hole/ and https://docs.pi-hole.net/
   pihole:
-    depends_on: 
+    depends_on:
       - caddy
     container_name: pihole
     #dns:  # Optional. Specify desired upstream DNS servers here.
@@ -37,17 +37,15 @@ services:
       # Following are NOT proxied through Caddy, bound to host net instead:
       - "53:53/udp"
       - "53:53/tcp"
-      - "853:853/tcp" # DNS-over-TLS 
+      - "853:853/tcp" # DNS-over-TLS
       #- "67:67/udp" # DHCP, if desired. If not bound to host net you need an mDNS proxy service configured somewhere on host net.
         # ref: https://docs.pi-hole.net/docker/DHCP/
     environment:
       TZ: 'America/New_York' # Supported TZ database names: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations
-      WEBPASSWORD: 'password' # Only used on first boot, change with pihole cli then comment out here.
+      FTLCONF_webserver_api_password: 'password'
     volumes:
       - './etc-pihole:/etc/pihole'
       - './etc-dnsmasq.d:/etc/dnsmasq.d'
-      - './etc-lighttpd/external.conf:/etc/lighttpd/external.conf'  # Recommend leave as bind mount for easier editing.
-        # ref for why you may need to change this file: https://docs.pi-hole.net/guides/webserver/caddy/#modifying-lighttpd-configuration
     #cap_add:  # Uncomment if using Pi-hole as DHCP server
       # https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
       #- NET_ADMIN # ONLY required if you are using Pi-hole as your DHCP server, else remove for better security

examples/docker-compose-example.yml

@@ -0,0 +1,25 @@
+version: "3"
+
+# More info at https://github.com/pi-hole/docker-pi-hole/ and https://docs.pi-hole.net/
+services:
+  pihole:
+    container_name: pihole
+    image: pihole/pihole:latest
+    # For DHCP it is recommended to remove these ports and instead add: network_mode: "host"
+    ports:
+      - "53:53/tcp"
+      - "53:53/udp"
+      - "67:67/udp" # Only required if you are using Pi-hole as your DHCP server
+      - "80:80/tcp"
+      - "443:443/tcp" # By default, FTL will generate a self-signed certificate
+    environment:
+      TZ: 'America/Chicago'
+      # FTLCONF_webserver_api_password: 'set a secure password here or it will be random'
+    # Volumes store your data between container upgrades
+    volumes:
+      - './etc-pihole:/etc/pihole'
+     # - './etc-dnsmasq.d:/etc/dnsmasq.d' # Only needed if you have some custom configs for dnsmasq
+    # https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
+    cap_add:
+      - NET_ADMIN # Required if you are using Pi-hole as your DHCP server, else not needed
+    restart: unless-stopped