Skip to content

Commit 28c2869

Browse files
Update README
1 parent 02b37cd commit 28c2869

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ files).
4949

5050
## Available Environment Variables
5151

52-
### Reuired
52+
### Required
5353
- `CERTBOT_EMAIL`: Your e-mail address. Used by Let's Encrypt to contact you in
5454
case of security issues.
5555

@@ -71,6 +71,7 @@ This option is for if you have downloaded this entire repository.
7171
Place any additional server configuration you desire inside the `nginx_conf.d/`
7272
folder and run the following command in your terminal while residing inside
7373
the `src/` folder.
74+
7475
```bash
7576
docker build --tag jonasal/nginx-certbot:latest .
7677
```
@@ -86,19 +87,20 @@ command where you copy in your own server configuration files.
8687
FROM jonasal/nginx-certbot:latest
8788
COPY conf.d/* /etc/nginx/conf.d/
8889
```
90+
8991
Don't forget to build it!
92+
9093
```bash
9194
docker build --tag jonasal/nginx-certbot:latest .
9295
```
9396

9497
### The `run` command
9598
Irregardless what option you chose above you run it with the following command:
99+
96100
```bash
97101
docker run -it --env [email protected] -p 80:80 -p 443:443 \
98102
-v nginx_secrets:/etc/letsencrypt jonasal/nginx-certbot:latest
99103
```
100-
The `CERTBOT_EMAIL` environment variable is required by Let's Encrypt, so they
101-
can contact you in case of security issues.
102104

103105
> You should be able to detach from the container by pressing
104106
`Ctrl`+`p`+`Ctrl`+`o`
@@ -171,7 +173,7 @@ should now be greeted with the string
171173
"`Let's Encrypt certificate successfully installed!`".
172174

173175
### How the script add domain names to certificate requests
174-
The included scripts will go trough all configuration files (`*.conf*`) it
176+
The included script will go trough all configuration files (`*.conf*`) it
175177
finds inside Nginx's `/etc/nginx/conf.d/` folder, and create requests from the
176178
file's content. In every unique file it will find any line that says:
177179

@@ -200,11 +202,11 @@ server {
200202
}
201203
```
202204

203-
will share the same certificate file, but the certbot command will include all
204-
listed domain variants. The limitation is that you should write all your
205-
server blocks that have the same primary domain in the same file. The
206-
certificate request from the above file will then become something like this
207-
(duplicates will be removed):
205+
will share the same certificate file (the "primary domain"), but the certbot
206+
command will include all listed domain variants. The limitation is that you
207+
should write all your server blocks that have the same primary domain in the
208+
same file. The certificate request from the above file will then become
209+
something like this (duplicates will be removed):
208210

209211
```
210212
certbot ... -d yourdomain.org -d www.yourdomain.org -d sub.yourdomain.org
@@ -273,18 +275,35 @@ mount.
273275

274276
# Changelog
275277

278+
### 0.13
279+
- Fixed the regex used in all of the `sed` commands.
280+
- Now makes sure that the proper amount of spaces are present in the right
281+
places.
282+
- Now allows comments at the end of the lines in the configs. `# Nice!`
283+
- Made the expression a little bit more readable thanks to the `-r` flag.
284+
- Now made certbot solely responsible for checking if the certificates needs to
285+
be renewed.
286+
- Certbot is actually smart enough to not send any renewal requests if it
287+
doesn't have to.
288+
- The time interval used to trigger the certbot renewal check is now user
289+
configurable.
290+
- The environmental variable to use is `RENEWAL_INTERVAL`.
291+
276292
### 0.12
277-
- Added `--cert-name` flag to certificate request.
278-
- This allows both adding and subtracting domains to the same certificate.
293+
- Added `--cert-name` flag to the certbot certificate request command.
294+
- This allows for both adding and subtracting domains to the same certificate
295+
file.
279296
- Makes it possible to have path names that are not domain names (but this
280-
is not allowed yet)
281-
- Made the file parsing functions smarter to only find unique file paths.
297+
is not allowed yet).
298+
- Made the file parsing functions smarter so they only find unique file paths.
282299
- Cleaned up some log output.
283300
- Updated the `docker-compose` example.
301+
- Fixed some spelling in the documentation.
284302

285303
### 0.11
286304
- Python 2 is EOL, so it's time to move over to Python 3.
287-
- From now on DockerHub will also build with tags (`jonasal/nginx-certbot:0.11`)
305+
- From now on DockerHub will also build with tags.
306+
- Lock the version by specifying the tag: `jonasal/nginx-certbot:0.11`
288307

289308
### 0.10
290309
- Update to new ACME v2 servers.

0 commit comments

Comments
 (0)