Skip to content

Commit

Permalink
Merge branch 'master' into dependabot/pip/acme-1.27.0
Browse files Browse the repository at this point in the history
  • Loading branch information
miff2000 authored Oct 11, 2022
2 parents 0968b59 + 61411cc commit 9045ef1
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SafeDNS Authenticator plugin for Certbot

## `ukfast/certbot-dns-safedns` - Docker image
## `ans-group/certbot-dns-safedns` - Docker image

### About
This container uses the SafeDNS Authenticator plugin for Certbot. It utilizes API calls to create and remove DNS TXT records for domain ownership validation.
Expand All @@ -14,8 +14,8 @@ mkdir -p /etc/letsencrypt

2, Create the `/etc/letsencrypt/safedns.ini` configuration file with the below content
```
certbot_dns_safedns:dns_safedns_auth_token = <YOUR API KEY HERE>
certbot_dns_safedns:dns_safedns_propagation_seconds = 60
dns_safedns_auth_token = <YOUR API KEY HERE>
dns_safedns_propagation_seconds = 60
```

3, Set permissions for the newly created configuration file
Expand All @@ -27,7 +27,7 @@ chmod 0600 /etc/letsencrypt/safedns.ini
```bash
docker run -it \
-v /etc/letsencrypt:/etc/letsencrypt \
ukfast/certbot-dns-safedns:latest \
ans-group/certbot-dns-safedns:latest \
certonly \
-d yourdomain.com \
--agree-tos \
Expand All @@ -42,23 +42,23 @@ docker run -it \
```bash
docker run -it \
-v /etc/letsencrypt:/etc/letsencrypt \
ukfast/certbot-dns-safedns:latest \
ans-group/certbot-dns-safedns:latest \
certificates
```

#### Delete a certificate
```bash
docker run -it \
-v /etc/letsencrypt:/etc/letsencrypt \
ukfast/certbot-dns-safedns:latest \
ans-group/certbot-dns-safedns:latest \
delete --cert-name yourdomain.com
```

#### Renew all certificates
```bash
docker run -it \
-v /etc/letsencrypt:/etc/letsencrypt \
ukfast/certbot-dns-safedns:latest \
ans-group/certbot-dns-safedns:latest \
renew
```

Expand Down Expand Up @@ -106,7 +106,7 @@ sudo pip install --upgrade pyopenssl

#### Credentials and Config Options

Use of this plugin can be simplified by using a configuration file containing SafeDNS API credentials, obtained from your MyUKFast [account page](https://my.ukfast.co.uk/applications/index.php). See also the [SafeDNS API](https://developers.ukfast.io/documentation/safedns) documentation.
Use of this plugin can be simplified by using a configuration file containing SafeDNS API credentials, obtained from your ANS Portal [account page](https://portal.ans.co.uk/applications/index.php). See also the [SafeDNS API](https://developers.ukfast.io/documentation/safedns) documentation.

An example `safedns.ini` file:

Expand All @@ -117,7 +117,7 @@ dns_safedns_propagation_seconds = 20

The path to this file can be provided interactively or using the `--dns_safedns-credentials` command-line argument. Certbot records the path to this file for use during renewal, but does not store the file's contents.

> **CAUTION:** You should protect these API credentials as you would the password to your MyUKFast account. Users who can read this file can use these credentials to issue arbitrary API calls on your behalf. Users who can cause Certbot to run using these credentials can complete a `dns-01` challenge to acquire new certificates or revoke existing certificates for associated domains, even if those domains aren't being managed by this server.
> **CAUTION:** You should protect these API credentials as you would the password to your ANS Portal account. Users who can read this file can use these credentials to issue arbitrary API calls on your behalf. Users who can cause Certbot to run using these credentials can complete a `dns-01` challenge to acquire new certificates or revoke existing certificates for associated domains, even if those domains aren't being managed by this server.
Certbot will emit a warning if it detects that the credentials file can be accessed by other users on your system. The warning reads "Unsafe permissions on credentials configuration file", followed by the path to the credentials file. This warning will be emitted each time Certbot uses the credentials file, including for renewal, and cannot be silenced except by addressing the issue (e.g., by using a command like `chmod 600` to restrict access to the file).

Expand Down
2 changes: 1 addition & 1 deletion local-oldest-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Remember to update setup.py to match the package versions below.
acme[dev]==0.31.0
certbot[dev]==0.34.0
dns-lexicon==3.9.5
dns-lexicon==3.11.5
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
acme==1.27.0
certbot==1.23.0
dns-lexicon==3.9.5
certbot==1.27.0
dns-lexicon==3.11.5

0 comments on commit 9045ef1

Please sign in to comment.