You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 6, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,6 @@
5
5
[](https://discourse.linuxserver.io"post on our community forum.")
6
6
[](https://fleet.linuxserver.io"an online web interface which displays all of our maintained images.")
7
7
[](https://github.com/linuxserver"view the source for all of our repositories.")
8
-
[](https://anchor.fm/linuxserverio"on hiatus. Coming back soon (late 2018).")
9
8
[](https://opencollective.com/linuxserver"please consider helping us by either donating or contributing to our budget")
10
9
11
10
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
@@ -22,7 +21,6 @@ Find us at:
22
21
*[Discourse](https://discourse.linuxserver.io) - post on our community forum.
23
22
*[Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
24
23
*[GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
25
-
*[Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
26
24
*[Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
@@ -137,7 +135,7 @@ Container images are configured using parameters passed at runtime (such as thos
137
135
|`-e URL=yourdomain.url`| Top url you have control over (`customdomain.com` if you own it, or `customsubdomain.ddnsprovider.com` if dynamic dns). |
138
136
|`-e SUBDOMAINS=www,`| 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) |
139
137
|`-e VALIDATION=http`| Letsencrypt validation method to use, options are `http`, `tls-sni`, `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`). |
140
-
|`-e DNSPLUGIN=cloudflare`| Required if `VALIDATION` is set to `dns`. Options are `cloudflare`, `cloudxns`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `google`, `inwx`, `linode`, `luadns`, `nsone`, `ovh`, `rfc2136`, `route53` and `transip`. Also need to enter the credentials into the corresponding ini file under `/config/dns-conf`. |
138
+
|`-e DNSPLUGIN=cloudflare`| Required if `VALIDATION` is set to `dns`. Options are `cloudflare`, `cloudxns`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `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`. |
141
139
|`-e DUCKDNSTOKEN=<token>`| Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org|
142
140
|`-e EMAIL=<e-mail>`| Optional e-mail address used for cert expiration notifications. |
143
141
|`-e DHLEVEL=2048`| Dhparams bit value (default=2048, can be set to `1024` or `4096`). |
@@ -146,6 +144,18 @@ Container images are configured using parameters passed at runtime (such as thos
146
144
|`-e STAGING=false`| 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. |
147
145
|`-v /config`| All the config files including the webroot reside here. |
148
146
147
+
## Environment variables from files (Docker secrets)
148
+
149
+
You can set any environment variable from a file by using a special prepend `FILE__`.
150
+
151
+
As an example:
152
+
153
+
```
154
+
-e FILE__PASSWORD=/run/secrets/mysecretpassword
155
+
```
156
+
157
+
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
158
+
149
159
## User / Group Identifiers
150
160
151
161
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
@@ -167,7 +177,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
167
177
* 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.).
168
178
* For `http` validation, port 80 on the internet side of the router should be forwarded to this container's port 80
169
179
* For `tls-sni` validation, port 443 on the internet side of the router should be forwarded to this container's port 443
170
-
* For `dns` validation, make sure to enter your credentials into the corresponding ini file under `/config/dns-conf`
180
+
* For `dns` validation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`
171
181
* 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"
172
182
* Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
173
183
* 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.
@@ -273,6 +283,8 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
273
283
274
284
## Versions
275
285
286
+
***18.12.19:** - Add php7-imap and php7-pecl-apcu.
287
+
***11.12.19:** - Fix Google Cloud DNS to use .json file for authentication.
276
288
***20.11.19:** - Fix cryptography version mismatch due to pip issue.
277
289
***17.11.19:** - Add php7-pdo_odbc.
278
290
***17.11.19:** - Add transip dns validation plugin.
Copy file name to clipboardExpand all lines: readme-vars.yml
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ cap_add_param_vars:
51
51
# optional container parameters
52
52
opt_param_usage_include_env: true
53
53
opt_param_env_vars:
54
-
- { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `cloudflare`, `cloudxns`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `google`, `inwx`, `linode`, `luadns`, `nsone`, `ovh`, `rfc2136`, `route53` and `transip`. Also need to enter the credentials into the corresponding ini file under `/config/dns-conf`." }
54
+
- { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `cloudflare`, `cloudxns`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `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`." }
55
55
- { env_var: "DUCKDNSTOKEN", env_value: "<token>", desc: "Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org" }
56
56
- { env_var: "EMAIL", env_value: "<e-mail>", desc: "Optional e-mail address used for cert expiration notifications." }
57
57
- { env_var: "DHLEVEL", env_value: "2048", desc: "Dhparams bit value (default=2048, can be set to `1024` or `4096`)." }
@@ -81,7 +81,7 @@ app_setup_block: |
81
81
* 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.).
82
82
* For `http` validation, port 80 on the internet side of the router should be forwarded to this container's port 80
83
83
* For `tls-sni` validation, port 443 on the internet side of the router should be forwarded to this container's port 443
84
-
* For `dns` validation, make sure to enter your credentials into the corresponding ini file under `/config/dns-conf`
84
+
* For `dns` validation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`
85
85
* 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"
86
86
* Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
87
87
* 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.
if [ ! -f "/config/keys/letsencrypt/fullchain.pem" ]; then
229
238
echo "Generating new certificate"
@@ -233,7 +242,7 @@ if [ ! -f "/config/keys/letsencrypt/fullchain.pem" ]; then
233
242
cd /config/keys/letsencrypt || exit
234
243
else
235
244
if [ "$VALIDATION" = "dns" ]; then
236
-
echo "ERROR: Cert does not exist! Please see the validation error above. Make sure you entered correct credentials into the /config/dns-conf/${DNSPLUGIN}.ini file."
245
+
echo "ERROR: Cert does not exist! Please see the validation error above. Make sure you entered correct credentials into the /config/dns-conf/${FILENAME} file."
237
246
elif [ "$VALIDATION" = "duckdns" ]; then
238
247
echo "ERROR: Cert does not exist! Please see the validation error above. Make sure your DUCKDNSTOKEN is correct."
0 commit comments