Merge pull request #661 from fawaf/master

use docker-compose example yaml
pi-hole · Aug 22, 2020 · 7199d93 · 7199d93
2 parents daa3c1e + 93b86c8
commit 7199d93
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,10 @@ UNKNOWN.egg-info
 .env
 ci-workspace
 .gh-workspace
+docker-compose.yml
+etc-dnsmasq.d/
+etc-pihole/
+var-log/
 
 # WIP/test stuff
 doco.yml
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@
 
 ## Quick Start
 
+1. Copy docker-compose-example.yml to docker-compose.yml and update as needed. See example below:
 [Docker-compose](https://docs.docker.com/compose/install/) example:
 
 ```yaml
@@ -36,6 +37,7 @@ services:
       - NET_ADMIN
     restart: unless-stopped
 ```
+2. Run `docker-compose up --detach` to build and start pi-hole
 
 [Here is an equivalent docker run script](https://github.com/pi-hole/docker-pi-hole/blob/master/docker_run.sh).
 

diff --git a/docker-compose.yml → docker-compose.yml.example b/docker-compose.yml → docker-compose.yml.example