From 01ffcd3907641ec65d3ef33092d34abf51a6d3f7 Mon Sep 17 00:00:00 2001
From: Josh Soref <jsoref@users.noreply.github.com>
Date: Tue, 5 Jun 2018 05:43:29 +0000
Subject: [PATCH 1/4] add periods to sentences
---
README.md | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 67700aa9..49610d9d 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Leaving the keys laying around your random boxes is too often a requirement to h
Acme-dns provides a simple API exclusively for TXT record updates and should be used with ACME magic "\_acme-challenge" - subdomain CNAME records. This way, in the unfortunate exposure of API keys, the effetcs are limited to the subdomain TXT record in question.
-So basically it boils down to **accessibility** and **security**
+So basically it boils down to **accessibility** and **security**.
## Features
- Simplified DNS server, serving your ACME DNS challenges (TXT)
@@ -111,37 +111,37 @@ Check out how in the INSTALL section.
## Installation
-1) Install [Go 1.9 or newer](https://golang.org/doc/install)
+1) Install [Go 1.9 or newer](https://golang.org/doc/install).
2) Install acme-dns: `go get github.com/joohoi/acme-dns/...`. This will install acme-dns to `~/go/bin/acme-dns`.
-3) 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`
+3) 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`.
4) 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.
1) Make sure that you have moved the configuration file to `/etc/acme-dns/config.cfg` so that acme-dns can access it globally.
- 2) Move the acme-dns executable from `~/go/bin/acme-dns` to `/usr/local/bin/acme-dns` (Any location will work, just be sure to change `acme-dns.service` to match)
+ 2) Move the acme-dns executable from `~/go/bin/acme-dns` to `/usr/local/bin/acme-dns` (Any location will work, just be sure to change `acme-dns.service` to match).
- 3) Create a minimal acme-dns user: `sudo adduser --system --gecos "acme-dns Service" --disabled-password --group --home /var/lib/acme-dns acme-dns`
+ 3) Create a minimal acme-dns user: `sudo adduser --system --gecos "acme-dns Service" --disabled-password --group --home /var/lib/acme-dns acme-dns`.
- 4) Move the systemd service unit from `acme-dns.service` to `/etc/systemd/system/acme-dns.service`
+ 4) Move the systemd service unit from `acme-dns.service` to `/etc/systemd/system/acme-dns.service`.
- 5) Reload systemd units: `sudo systemctl daemon-reload`
+ 5) Reload systemd units: `sudo systemctl daemon-reload`.
- 6) Enable acme-dns on boot: `sudo systemctl enable acme-dns.service`
+ 6) Enable acme-dns on boot: `sudo systemctl enable acme-dns.service`.
- 7) Run acme-dns: `sudo systemctl start acme-dns.service`
+ 7) Run acme-dns: `sudo systemctl start acme-dns.service`.
5) If you did not install the systemd service, run acme-dns. Please note that acme-dns needs to open a privileged port (53, domain), so it needs to be run with elevated privileges.
### Using Docker
-1) Pull the latest acme-dns Docker image: `docker pull joohoi/acme-dns`
+1) Pull the latest acme-dns Docker image: `docker pull joohoi/acme-dns`.
2) Create directories: `config` for the configuration file, and `data` for the sqlite3 database.
-3) Copy [configuration template](https://raw.githubusercontent.com/joohoi/acme-dns/master/config.cfg) to `config/config.cfg`
+3) Copy [configuration template](https://raw.githubusercontent.com/joohoi/acme-dns/master/config.cfg) to `config/config.cfg`.
4) Modify the config.cfg to suit your needs.
@@ -159,11 +159,11 @@ docker run --rm --name acmedns \
1) Create directories: `config` for the configuration file, and `data` for the sqlite3 database.
-2) Copy [configuration template](https://raw.githubusercontent.com/joohoi/acme-dns/master/config.cfg) to `config/config.cfg`
+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.
-4) Edit the `config/config.cfg` and `docker-compose.yml` to suit your needs, and run `docker-compose up -d`
+4) Edit the `config/config.cfg` and `docker-compose.yml` to suit your needs, and run `docker-compose up -d`.
## DNS Records
@@ -177,14 +177,14 @@ These values should be changed based on your environment.
You will need to add some DNS records on your domain's regular DNS server:
- `NS` record for `auth.example.com` pointing to `ns.auth.example.com`
- `A` record for `ns.auth.example.com` pointing to `198.51.100.1`
-- If using IPv6, an `AAAA` record pointing to the IPv6 address
+- If using IPv6, an `AAAA` record pointing to the IPv6 address.
- Each domain you will be authenticating will need a `CNAME` for a `_acme-challenge` subdomain added. The [client](README.md#clients) you use will explain how to do this.
## Testing It Out
You may want to test that acme-dns is working before using it for real queries.
-1) Confirm that DNS lookups for the acme-dns subdomain works as expected: `dig auth.example.com`
+1) Confirm that DNS lookups for the acme-dns subdomain works as expected: `dig auth.example.com`.
2) Call the `/register` API endpoint to register a test domain:
```
From c63b407c507265b8f4b5fb2a0a84c73906427a79 Mon Sep 17 00:00:00 2001
From: Josh Soref <jsoref@users.noreply.github.com>
Date: Tue, 5 Jun 2018 05:44:18 +0000
Subject: [PATCH 2/4] markdown
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 49610d9d..3a3e017c 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ The method returns a new unique subdomain and credentials needed to update your
Fulldomain is where you can point your own `_acme-challenge` subdomain CNAME record to.
With the credentials, you can update the TXT response in the service to match the challenge token, later referred as \_\_\_validation\_token\_recieved\_from\_the\_ca\_\_\_, given out by the Certificate Authority.
-**Optional:**: You can POST JSON data to limit the /update requests to predefined source networks using CIDR notation.
+**Optional:**: You can POST JSON data to limit the `/update` requests to predefined source networks using CIDR notation.
```POST /register```
@@ -133,7 +133,7 @@ Check out how in the INSTALL section.
7) Run acme-dns: `sudo systemctl start acme-dns.service`.
-5) If you did not install the systemd service, run acme-dns. Please note that acme-dns needs to open a privileged port (53, domain), so it needs to be run with elevated privileges.
+5) If you did not install the systemd service, run `acme-dns`. Please note that acme-dns needs to open a privileged port (53, domain), so it needs to be run with elevated privileges.
### Using Docker
@@ -143,9 +143,9 @@ Check out how in the INSTALL section.
3) Copy [configuration template](https://raw.githubusercontent.com/joohoi/acme-dns/master/config.cfg) to `config/config.cfg`.
-4) Modify the config.cfg to suit your needs.
+4) Modify the `config.cfg` to suit your needs.
-5) Run Docker, this example expects that you have `port = "80"` in your config.cfg:
+5) Run Docker, this example expects that you have `port = "80"` in your `config.cfg`:
```
docker run --rm --name acmedns \
-p 53:53 \
From 94b2fa1a39e5418738c6d1d58936c1f2bf34931f Mon Sep 17 00:00:00 2001
From: Josh Soref <jsoref@users.noreply.github.com>
Date: Tue, 5 Jun 2018 05:45:20 +0000
Subject: [PATCH 3/4] reword
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 3a3e017c..c3344456 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ Using acme-dns is a three-step process (provided you already have the self-hoste
- Get credentials and unique subdomain (simple POST request to eg. https://auth.acme-dns.io/register)
- Create a (ACME magic) CNAME record to your existing zone, pointing to the subdomain you got from the registration. (eg. `_acme-challenge.domainiwantcertfor.tld. CNAME a097455b-52cc-4569-90c8-7a4b97c6eba8.auth.example.org` )
-- Use your credentials to POST a new DNS challenge values to an acme-dns server for the CA to validate them off of.
+- Use your credentials to POST new DNS challenge values to an acme-dns server for the CA to validate from.
- Crontab and forget.
## API
@@ -106,7 +106,7 @@ The method allows you to update the TXT answer contents of your unique subdomain
You are encouraged to run your own acme-dns instance, because you are effectively authorizing the acme-dns server to act on your behalf in providing the answer to challengeing CA, making the instance able to request (and get issued) a TLS certificate for the domain that has CNAME pointing to it.
-Check out how in the INSTALL section.
+See the INSTALL section for information on how to do this.
## Installation
From 2dd1bcb02f1235c49bd9f9151f085b85fd93e946 Mon Sep 17 00:00:00 2001
From: Josh Soref <jsoref@users.noreply.github.com>
Date: Tue, 5 Jun 2018 05:45:58 +0000
Subject: [PATCH 4/4] reword: the item _acme-challenge should be a cname, not a
cname to _acme-challenge
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c3344456..a5614879 100644
--- a/README.md
+++ b/README.md
@@ -178,7 +178,7 @@ You will need to add some DNS records on your domain's regular DNS server:
- `NS` record for `auth.example.com` pointing to `ns.auth.example.com`
- `A` record for `ns.auth.example.com` pointing to `198.51.100.1`
- If using IPv6, an `AAAA` record pointing to the IPv6 address.
-- Each domain you will be authenticating will need a `CNAME` for a `_acme-challenge` subdomain added. The [client](README.md#clients) you use will explain how to do this.
+- Each domain you will be authenticating will need a `_acme-challenge` `CNAME` subdomain added. The [client](README.md#clients) you use will explain how to do this.
## Testing It Out