forked from linuxserver/docker-letsencrypt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme-vars.yml
executable file
·238 lines (227 loc) · 21.8 KB
/
readme-vars.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
---
# project information
project_name: letsencrypt
project_url: "https://letsencrypt.org/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/le-logo-wide.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) sets up an Nginx webserver and reverse proxy with php support and a built-in letsencrypt client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb_optional_extras_enabled: false
project_blurb_optional_extras: []
# supported architectures
available_architectures:
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
- { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
# development version
development_versions: false
development_versions_items:
- { tag: "latest", desc: "Stable releases" }
- { tag: "development", desc: "Releases from the `develop` branch" }
# container parameters
common_param_env_vars_enabled: true #PGID, PUID, etc, you can set it to 'optional'
param_container_name: "{{ project_name }}"
param_usage_include_net: false #you can set it to 'optional'
param_net: "host"
param_net_desc: "Shares host networking with container."
param_usage_include_env: true
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
- { env_var: "URL", env_value: "yourdomain.url", desc: "Top url you have control over (`customdomain.com` if you own it, or `customsubdomain.ddnsprovider.com` if dynamic dns)." }
- { env_var: "SUBDOMAINS", env_value: "www,", desc: "Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` (wildcard cert is available via `dns` and `duckdns` validation only)" }
- { env_var: "VALIDATION", env_value: "http", desc: "Letsencrypt validation method to use, options are `http`, `dns` or `duckdns` (`dns` method also requires `DNSPLUGIN` variable set) (`duckdns` method requires `DUCKDNSTOKEN` variable set, and the `SUBDOMAINS` variable must be either empty or set to `wildcard`)." }
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "All the config files including the webroot reside here." }
param_usage_include_ports: true
param_ports:
- { external_port: "443", internal_port: "443", port_desc: "Https port" }
param_device_map: false
param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
cap_add_param: true
cap_add_param_vars:
- { cap_add_var: "NET_ADMIN" }
# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
- { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `aliyun`, `cloudflare`, `cloudxns`, `cpanel`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `domeneshop`, `gandi`, `google`, `inwx`, `linode`, `luadns`, `nsone`, `ovh`, `rfc2136`, `route53` and `transip`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`." }
- { env_var: "PROPAGATION", env_value: "", desc: "Optionally override (in seconds) the default propagation time for the dns plugins." }
- { env_var: "DUCKDNSTOKEN", env_value: "", desc: "Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org" }
- { env_var: "EMAIL", env_value: "", desc: "Optional e-mail address used for cert expiration notifications." }
- { env_var: "DHLEVEL", env_value: "2048", desc: "Dhparams bit value (default=2048, can be set to `1024` or `4096`)." }
- { env_var: "ONLY_SUBDOMAINS", env_value: "false", desc: "If you wish to get certs only for certain subdomains, but not the main domain (main domain may be hosted on another machine and cannot be validated), set this to `true`" }
- { env_var: "EXTRA_DOMAINS", env_value: "", desc: "Additional fully qualified domain names (comma separated, no spaces) ie. `extradomain.com,subdomain.anotherdomain.org`" }
- { env_var: "STAGING", env_value: "false", desc: "Set to `true` to retrieve certs in staging mode. Rate limits will be much higher, but the resulting cert will not pass the browser's security test. Only to be used for testing purposes." }
opt_param_usage_include_vols: false
opt_param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Configuration files." }
opt_param_usage_include_ports: true
opt_param_ports:
- { external_port: "80", internal_port: "80", port_desc: "Http port (required for http validation only)" }
opt_param_device_map: false
opt_param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
opt_cap_add_param: false
opt_cap_add_param_vars:
- { cap_add_var: "NET_ADMIN" }
optional_block_1: false
optional_block_1_items: ""
# application setup block
app_setup_block_enabled: true
app_setup_block: |
### Validation and initial setup
* Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 (and/or 80) is not being used by another service on the host (NAS gui, another webserver, etc.).
* For `http` validation, port 80 on the internet side of the router should be forwarded to this container's port 80
* For `dns` validation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`
* Cloudflare provides free accounts for managing dns and is very easy to use with this image. Make sure that it is set up for "dns only" instead of "dns + proxy"
* Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
* For `duckdns` validation, either leave the `SUBDOMAINS` variable empty or set it to `wildcard`, and set the `DUCKDNSTOKEN` variable with your duckdns token. Due to a limitation of duckdns, the resulting cert will only cover either main subdomain (ie. `yoursubdomain.duckdns.org`), or sub-subdomains (ie. `*.yoursubdomain.duckdns.org`), but will not both at the same time. You can use our [duckdns image](https://hub.docker.com/r/linuxserver/duckdns/) to update your IP on duckdns.org.
* `--cap-add=NET_ADMIN` is required for fail2ban to modify iptables
* If you need a dynamic dns provider, you can use the free provider duckdns.org where the `URL` will be `yoursubdomain.duckdns.org` and the `SUBDOMAINS` can be `www,ftp,cloud` with http validation, or `wildcard` with dns validation.
* After setup, navigate to `https://yourdomain.url` to access the default homepage (http access through port 80 is disabled by default, you can enable it by editing the default site config at `/config/nginx/site-confs/default`).
* Certs are checked nightly and if expiration is within 30 days, renewal is attempted. If your cert is about to expire in less than 30 days, check the logs under `/config/log/letsencrypt` to see why the renewals have been failing. It is recommended to input your e-mail in docker parameters so you receive expiration notices from letsencrypt in those circumstances.
### Security and password protection
* The container detects changes to url and subdomains, revokes existing certs and generates new ones during start. It also detects changes to the DHLEVEL parameter and replaces the dhparams file.
* If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it letsencrypt htpasswd -c /config/nginx/.htpasswd <username>`
* You can add multiple user:pass to `.htpasswd`. For the first user, use the above command, for others, use the above command without the `-c` flag, as it will force deletion of the existing `.htpasswd` and creation of a new one
* You can also use ldap auth for security and access control. A sample, user configurable ldap.conf is provided, and it requires the separate image [linuxserver/ldap-auth](https://hub.docker.com/r/linuxserver/ldap-auth/) to communicate with an ldap server.
### Site config and reverse proxy
* The default site config resides at `/config/nginx/site-confs/default`. Feel free to modify this file, and you can add other conf files to this directory. However, if you delete the `default` file, a new default will be created on container start.
* Preset reverse proxy config files are added for popular apps. See the `README.md` file under `/config/nginx/proxy_confs` for instructions on how to enable them. The preset confs reside in and get imported from [this repo](https://github.com/linuxserver/reverse-proxy-confs).
* If you wish to hide your site from search engine crawlers, you may find it useful to add this configuration line to your site config, within the server block, above the line where ssl.conf is included
`add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";`
This will *ask* Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines
### Using certs in other containers
* This container includes auto-generated pfx and private-fullchain-bundle pem certs that are needed by other apps like Emby and Znc.
* To use these certs in other containers, do either of the following:
1. *(Easier)* Mount the letsencrypt config folder in other containers (ie. `-v /path-to-le-config:/le-ssl`) and in the other containers, use the cert location `/le-ssl/keys/letsencrypt/`
2. *(More secure)* Mount the letsencrypt folder `etc/letsencrypt` that resides under `/config` in other containers (ie. `-v /path-to-le-config/etc/letsencrypt:/le-ssl`) and in the other containers, use the cert location `/le-ssl/live/<your.domain.url>/` (This is more secure because the first method shares the entire letsencrypt config folder with other containers, including the www files, whereas the second method only shares the ssl certs)
* These certs include:
1. `cert.pem`, `chain.pem`, `fullchain.pem` and `privkey.pem`, which are generated by letsencrypt and used by nginx and various other apps
2. `privkey.pfx`, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server (no password)
3. `priv-fullchain-bundle.pem`, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
### Using fail2ban
* This container includes fail2ban set up with 3 jails by default:
1. nginx-http-auth
2. nginx-badbots
3. nginx-botsearch
* To enable or disable other jails, modify the file `/config/fail2ban/jail.local`
* To modify filters and actions, instead of editing the `.conf` files, create `.local` files with the same name and edit those because .conf files get overwritten when the actions and filters are updated. `.local` files will append whatever's in the `.conf` files (ie. `nginx-http-auth.conf` --> `nginx-http-auth.local`)
* You can check which jails are active via `docker exec -it letsencrypt fail2ban-client status`
* You can check the status of a specific jail via `docker exec -it letsencrypt fail2ban-client status <jail name>`
* You can unban an IP via `docker exec -it letsencrypt fail2ban-client set <jail name> unbanip <IP>`
* A list of commands can be found here: https://www.fail2ban.org/wiki/index.php/Commands
app_setup_nginx_reverse_proxy_snippet: false
app_setup_nginx_reverse_proxy_block: ""
# changelog
changelogs:
- { date: "04.05.20:", desc: "Allow for optionally setting propagation time for dns plugins. Add repo version of `whois` to replace the built-in busybox version. Update `jail.local` to change default fail2ban ban action to more widely supported `iptables-allports`." }
- { date: "13.04.20:", desc: "Update cloudflare.ini with token info." }
- { date: "11.03.20:", desc: "Add php7-sodium." }
- { date: "06.03.20:", desc: "Implement cert renewal attempt during container start (only if the cert is already expired or will expire within the next 24 hours, otherwise it will be attempted at 2:08am)." }
- { date: "05.03.20:", desc: "Use port and proto upstream variables for ldap and default sample confs." }
- { date: "24.02.20:", desc: "Remove world/group read permissions in dns-conf." }
- { date: "23.02.20:", desc: "Add aliyun dns validation plugin." }
- { date: "28.01.20:", desc: "Deprecate tls-sni validation method, remove from docs." }
- { date: "27.01.20:", desc: "Add support for cpanel dns validation." }
- { date: "10.01.20:", desc: "Add support for domeneshop dns validation." }
- { date: "07.01.20:", desc: "Update ciphers from Mozilla ssl-config recommendations." }
- { date: "01.01.20:", desc: "Add support for gandi dns validation." }
- { date: "31.12.19:", desc: "GeoIP2 databases now require personal license keys to download. Auto download is disabled and log message is added." }
- { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
- { date: "19.12.19:", desc: "Increase large_client_header_buffers in nginx.conf to prevent 414 errors." }
- { date: "18.12.19:", desc: "Add php7-imap and php7-pecl-apcu." }
- { date: "11.12.19:", desc: "Fix Google Cloud DNS to use .json file for authentication." }
- { date: "20.11.19:", desc: "Fix cryptography version mismatch due to pip issue." }
- { date: "17.11.19:", desc: "Add php7-pdo_odbc." }
- { date: "17.11.19:", desc: "Add transip dns validation plugin." }
- { date: "27.10.19:", desc: "Turn off lua resty core to get rid of error message in the log (existing users will have to delete `/config/nginx/nginx.conf` and restart the container)." }
- { date: "26.10.19:", desc: "Add new package for stream-geoip2, remove geoip2 module patch." }
- { date: "24.10.19:", desc: "Add php7-pecl-imagick." }
- { date: "23.10.19:", desc: "Update Host header in `proxy.conf` to fix CSRF issues." }
- { date: "12.10.19:", desc: "Add linode dns validation plugin." }
- { date: "23.09.19:", desc: "Move GeoIP2 db to /config to make it persistent." }
- { date: "14.08.19:", desc: "Add inwx dns validation plugin." }
- { date: "06.08.19:", desc: "Add php7-ftp." }
- { date: "04.08.19:", desc: "Add php7-bcmath, php7-pear, php7-xmlrpc." }
- { date: "02.08.19:", desc: "Add php7-ldap, remove geoip v1(deprecated)." }
- { date: "01.08.19:", desc: "Mark https redirect block as default_server (effective only for new installs)." }
- { date: "31.07.19:", desc: "Create GeoIP2 databse (libmaxminddb) during container start if it doesn't exist." }
- { date: "30.07.19:", desc: "Support main domain via duckdns validation." }
- { date: "29.07.19:", desc: "Enable http to https redirect by default (effective only for new installs)." }
- { date: "01.07.19:", desc: "Patch geoip2 module until upstream is fixed." }
- { date: "30.06.19:", desc: "Add geoip2 module." }
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
- { date: "19.06.19:", desc: "Set resolver to docker dns in ssl.conf." }
- { date: "29.05.19:", desc: "Compensate for changes to the reverse-proxy-confs repo." }
- { date: "26.05.19:", desc: "Remove botocore/urllib patch." }
- { date: "08.05.19:", desc: "Remove default.conf when nginx is upgraded in downstream image." }
- { date: "30.04.19:", desc: "Add php-redis." }
- { date: "12.04.19:", desc: "Rebase aarch64 image to 3.9." }
- { date: "25.03.19:", desc: "Rebase aarch64 image back to 3.8 due to python issues (specifically with fail2ban), switch packages to python 3 on amd64 and armhf, clean up pip/python cache to shrink image size." }
- { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
- { date: "10.03.19:", desc: "Add TLSv1.3 to ssl.conf." }
- { date: "02.03.19:", desc: "Add php intl and posix modules." }
- { date: "27.02.19:", desc: "Add gnupg package." }
- { date: "22.02.19:", desc: "Rebase to alpine 3.9." }
- { date: "03.02.19:", desc: "Removed memcached due to seccomp errors. Let us know if you need to re-enable memcached." }
- { date: "28.01.19:", desc: "Add pipeline logic and multi arch." }
- { date: "21.01.19:", desc: "Remove client_body_max from proxy.conf (existing users need to manually update)." }
- { date: "09.01.19:", desc: "Remove tls v1 and v1.1 from default ssl.conf, update ciphers (existing users need to manually update)." }
- { date: "30.12.18:", desc: "Fix bundle key generation." }
- { date: "19.12.18:", desc: "Add ipv6 and http/2 support to default site config." }
- { date: "08.12.18:", desc: "Had to remove cert renewal during container start due to certbot's new undocumented `feature` of up to 8 minute random delay." }
- { date: "03.12.18:", desc: "Fix silly bug resetting the duckdns token." }
- { date: "02.12.18:", desc: "Add dns validation support for ovh." }
- { date: "20.11.18:", desc: "Externalize reverse proxy confs to separate github repo `linuxserver/reverse-proxy-confs`, update baseimage packages during build" }
- { date: "19.11.18:", desc: "Add php opcache package." }
- { date: "12.11.18:", desc: "Add support for duckdns wildcard certs via dns validation" }
- { date: "31.10.18:", desc: "Add various preset proxy confs and fix others (thanks @nemchik and @hijxf)" }
- { date: "02.10.18:", desc: "Fix fail2ban instructions and logrotate conf" }
- { date: "11.09.18:", desc: "Add various preset proxy confs and fix others (thanks @nemchik and @LeoVerto)" }
- { date: "04.09.18:", desc: "Linting fixes." }
- { date: "30.08.18:", desc: "Add support for ldap auth, add proxy confs for bazarr, couchpotato, headphones, lidarr and plex subfolder (thanks @nemchik and @jedahan)" }
- { date: "21.08.18:", desc: "Rebase to alpine 3.8, add info on search engine de-listing" }
- { date: "08.08.18:", desc: "Add subdomain proxy conf for plex, update emby proxy confs" }
- { date: "25.07.18:", desc: "Add subdomain proxy conf for syncthing" }
- { date: "23.07.18:", desc: "Remove backwards compatibility and set default validation method to http. Update portainer proxy config to fix websockets. Add unifi proxy conf." }
- { date: "31.05.18:", desc: "Update ssl.conf and proxy.conf for tighter security (thanks @nemchik)" }
- { date: "30.05.18:", desc: "Add reverse proxy configs for jackett, monitorr, nzbget, nzbhydra, organizr, portainer and transmission (thanks @nemchik)" }
- { date: "18.05.18:", desc: "Add more info on certs and unraid reverse proxy config" }
- { date: "11.05.18:", desc: "Add php pgsql support" }
- { date: "24.04.18:", desc: "Auto generate a private key + fullchain bundle pem that is needed by certain apps" }
- { date: "20.04.18:", desc: "Add standardized optional reverse proxy conf files" }
- { date: "19.04.18:", desc: "Bind memcached to localhost only, add php7-sqlite3" }
- { date: "08.04.18:", desc: "Fix renewal hooks" }
- { date: "29.03.18:", desc: "Create pfx cert after renewal for dns validation (previous version only created it for http and tls, an oversight)" }
- { date: "29.03.18:", desc: "Fix staging for v2 api" }
- { date: "13.03.18:", desc: "Support for wildcard cert with dns validation added. Switched to v2 api for ACME." }
- { date: "21.02.18:", desc: "Reduce shellcheck directives by renaming secondary variables" }
- { date: "20.02.18:", desc: "Sanitize variables, increase log verbosity" }
- { date: "01.02.18:", desc: "Big changes. `VALIDATION` parameter added for choosing letsencrypt validation methods, including dns through official plugins. `HTTPVAL` is deprecated. `STAGING` parameter added for testing. Backwards compatibility for the short term. Since tls-sni is disabled by letsencrypt, most users will have to change their settings and adopt the new parameters within the next 90 days. Reorganized the nginx default config, split ssl settings into new ssl.conf" }
- { date: "13.01.18:", desc: "Re-enable ipv6 due to update to fail2ban 0.10.1. Existing users can enable ipv6 by deleting `/config/fail2ban/action.d/iptables-common.local` and restarting the container after updating the image" }
- { date: "11.01.18:", desc: "Halt the container if validation fails instead of a stop (so restart=always doesn't get users throttled with letsencrypt)" }
- { date: "10.01.18:", desc: "Add option for http validation on port 80" }
- { date: "05.01.18:", desc: "Rebase to alpine 3.7" }
- { date: "04.11.17:", desc: "Add php7 soap module" }
- { date: "31.10.17:", desc: "Add php7 exif and xmlreader modules" }
- { date: "25.09.17:", desc: "Manage fail2ban via s6" }
- { date: "24.09.17:", desc: "Add memcached service" }
- { date: "01.09.17:", desc: "`--privileged` is no longer required as long as `--cap-add=NET_ADMIN` is added, instructions modified accordingly, disabled fail2ban ipv6 actions due to requiring access to host kernel modules" }
- { date: "31.08.17:", desc: "Add php7-phar" }
- { date: "14.07.17:", desc: "Enable modules dynamically in nginx.conf" }
- { date: "06.07.17:", desc: "Add support for multiple domains (thanks @oznu)" }
- { date: "22.06.17:", desc: "Add various nginx modules and enable all modules in the default nginx.conf" }
- { date: "16.06.17:", desc: "Update deprecated certbot option for https validation, make e-mail entry optional, update readme" }
- { date: "05.06.17:", desc: "Add php7-bz2" }
- { date: "27.05.17:", desc: "Rebase to alpine 3.6." }
- { date: "03.05.17:", desc: "Fix log permissions." }
- { date: "18.04.17:", desc: "Add php7-sockets, update fail2ban filter and action defaults" }
- { date: "27.02.17:", desc: "Add php7-dom, php7-iconv and php7-pdo_sqlite" }
- { date: "21.02.17:", desc: "Add php7-xml" }
- { date: "10.02.17:", desc: "Switch to alpine 3.5 base and php7, add php zlib module and all nginx modules" }
- { date: "13.01.17:", desc: "Add php5-ctype and php5-openssl" }
- { date: "04.01.17:", desc: "Add php5-mysqli and php5-pdo_mysql" }
- { date: "22.11.16:", desc: "Add gd and mcrypt packages" }
- { date: "21.11.16:", desc: "Add curl package" }
- { date: "07.11.16:", desc: "Initial Release" }