From 7e755f2b57d6f37eea4d774f65601c3c137ddd61 Mon Sep 17 00:00:00 2001 From: Felix Wong Date: Wed, 24 Mar 2021 09:21:00 +0000 Subject: [PATCH 1/2] add config.cfg example file --- .gitignore | 1 + README.md | 2 +- config.cfg => config/config.cfg.example | 0 3 files changed, 2 insertions(+), 1 deletion(-) rename config.cfg => config/config.cfg.example (100%) diff --git a/.gitignore b/.gitignore index e7f4e384..56a89aeb 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ acme-dns.log .vagrant coverage.out .idea/ +config/config.cfg diff --git a/README.md b/README.md index 57efe7c5..a5daa133 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,7 @@ go build 3) Move the built acme-dns binary to a directory in your $PATH, for example: `sudo mv acme-dns /usr/local/bin` -4) Edit config.cfg to suit your needs (see [configuration](#configuration)). `acme-dns` will read the configuration file from `/etc/acme-dns/config.cfg` or `./config.cfg`, or a location specified with the `-c` flag. +4) Copy config/config.cfg.example to config/config.cfg. Edit config/config.cfg to suit your needs (see [configuration](#configuration)). `acme-dns` will read the configuration file from `/etc/acme-dns/config.cfg` or `./config.cfg`, or a location specified with the `-c` flag. 5) If your system has systemd, you can optionally install acme-dns as a service so that it will start on boot and be tracked by systemd. This also allows us to add the `CAP_NET_BIND_SERVICE` capability so that acme-dns can be run by a user other than root. diff --git a/config.cfg b/config/config.cfg.example similarity index 100% rename from config.cfg rename to config/config.cfg.example From 77511fbba81d7b56d94771b01f121587ca66aa99 Mon Sep 17 00:00:00 2001 From: Felix Wong Date: Fri, 21 Jan 2022 07:19:31 +0000 Subject: [PATCH 2/2] use example docker-compose file --- .gitignore | 1 + README.md | 2 +- docker-compose.yml => docker-compose.yml.example | 0 3 files changed, 2 insertions(+), 1 deletion(-) rename docker-compose.yml => docker-compose.yml.example (100%) diff --git a/.gitignore b/.gitignore index 56a89aeb..9aacb8d9 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ acme-dns.log coverage.out .idea/ config/config.cfg +docker-compose.yml diff --git a/README.md b/README.md index a5daa133..8ccf46e5 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ docker run --rm --name acmedns \ 2) Copy [configuration template](https://raw.githubusercontent.com/joohoi/acme-dns/master/config.cfg) to `config/config.cfg`. -3) Copy [docker-compose.yml from the project](https://raw.githubusercontent.com/joohoi/acme-dns/master/docker-compose.yml), or create your own. +3) Copy [docker-compose.yml.example](https://raw.githubusercontent.com/joohoi/acme-dns/master/docker-compose.yml.example) to docker-compose.yml and edit as needed. 4) Edit the `config/config.cfg` and `docker-compose.yml` to suit your needs, and run `docker-compose up -d`. 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