From 93b86c8981d5804546f2c4562d7af334ab2a3564 Mon Sep 17 00:00:00 2001 From: Felix Wong Date: Thu, 16 Apr 2020 00:32:38 +0000 Subject: [PATCH] use docker-compose example yaml Signed-off-by: Felix Wong --- .gitignore | 4 ++++ README.md | 2 ++ docker-compose.yml => docker-compose.yml.example | 0 3 files changed, 6 insertions(+) rename docker-compose.yml => docker-compose.yml.example (100%) diff --git a/.gitignore b/.gitignore index 4e7bc94..e8f6ff4 100644 --- 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 index 9a05db6..e27a2c5 100644 --- 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 b/docker-compose.yml.example similarity index 100% rename from docker-compose.yml rename to docker-compose.yml.example