Update 'README.md'
This commit is contained in:
parent
8f8dc942ff
commit
497f8e61e3
283
README.md
283
README.md
@ -1,117 +1,166 @@
|
|||||||
|
Conigure fail2ban for docker:
|
||||||
[](https://github.com/nginx-proxy/acme-companion/releases)
|
|
||||||
[](https://hub.docker.com/r/nginxproxy/acme-companion "Click to view the image on Docker Hub")
|
1 - Create volume for nginx in -volumes
|
||||||
[](https://hub.docker.com/r/nginxproxy/acme-companion "Click to view the image on Docker Hub")
|
"./log:/var/log/nginx/"
|
||||||
[](https://hub.docker.com/r/nginxproxy/acme-companion "Click to view the image on Docker Hub")
|
|
||||||
|
Then add following lines to /etc/fail2ban/jail.local
|
||||||
**acme-companion** is a lightweight companion container for [**nginx-proxy**](https://github.com/nginx-proxy/nginx-proxy).
|
|
||||||
|
[nginx-http-auth]
|
||||||
It handles the automated creation, renewal and use of SSL certificates for proxied Docker containers through the ACME protocol.
|
enabled = true
|
||||||
|
port = http,https
|
||||||
**Required read if you use the `latest` version** : the `v2.0.0` release of this project mark the switch of the ACME client used by the Docker image from [**simp.le**](https://github.com/zenhack/simp_le) to [**acme.sh**](https://github.com/acmesh-official/acme.sh). This switch result in some backward incompatible changes, so please read [this issue](https://github.com/nginx-proxy/acme-companion/issues/510) and the updated docs for more details before updating your image. The single most important change is that the container now requires a volume mounted to `/etc/acme.sh` in order to persist ACME account keys and SSL certificates. The last tagged version that uses **simp_le** is `v1.13.1`.
|
logpath = /opt/container_webservice/logs/error.log
|
||||||
|
banaction = iptables-multiport-forward
|
||||||
### Features:
|
|
||||||
* Automated creation/renewal of Let's Encrypt (or other ACME CAs) certificates using [**acme.sh**](https://github.com/acmesh-official/acme.sh).
|
[nginx-limit-req]
|
||||||
* Let's Encrypt / ACME domain validation through `http-01` challenge only.
|
enabled = true
|
||||||
* Automated update and reload of nginx config on certificate creation/renewal.
|
port = http,https
|
||||||
* Support creation of [Multi-Domain (SAN) Certificates](https://github.com/nginx-proxy/acme-companion/blob/main/docs/Let's-Encrypt-and-ACME.md#multi-domains-certificates).
|
logpath = /opt/container_webservice/logs/error.log
|
||||||
* Creation of a Strong Diffie-Hellman Group at startup.
|
banaction = iptables-multiport-forward
|
||||||
* Work with all versions of docker.
|
|
||||||
|
[nginx-botsearch]
|
||||||
### Requirements:
|
enabled = true
|
||||||
* Your host **must** be publicly reachable on **both** port `80` and `443`.
|
port = http,https
|
||||||
* Check your firewall rules and **do not attempt to block port `80`** as that will prevent `http-01` challenges from completing.
|
maxretry = 2
|
||||||
* For the same reason, you can't use nginx-proxy's [`HTTPS_METHOD=nohttp`](https://github.com/nginx-proxy/nginx-proxy#how-ssl-support-works).
|
logpath = /opt/container_webservice/logs/error.log
|
||||||
* The (sub)domains you want to issue certificates for must correctly resolve to the host.
|
banaction = iptables-multiport-forward
|
||||||
* Your DNS provider must [answer correctly to CAA record requests](https://letsencrypt.org/docs/caa/).
|
|
||||||
* If your (sub)domains have AAAA records set, the host must be publicly reachable over IPv6 on port `80` and `443`.
|
[php-url-fopen]
|
||||||
|
enabled = true
|
||||||
|
port = http,https
|
||||||
|
logpath = /opt/container_webservice/logs/access.log
|
||||||
## Basic usage (with the nginx-proxy container)
|
banaction = iptables-multiport-forward
|
||||||
|
|
||||||
Three writable volumes must be declared on the **nginx-proxy** container so that they can be shared with the **acme-companion** container:
|
Adjust logpath (usually /home/user/acme-companion/log/error.log)
|
||||||
|
|
||||||
* `/etc/nginx/certs` to store certificates and private keys (readonly for the **nginx-proxy** container).
|
Then:
|
||||||
* `/etc/nginx/vhost.d` to change the configuration of vhosts (required so the CA may access `http-01` challenge files).
|
|
||||||
* `/usr/share/nginx/html` to write `http-01` challenge files.
|
cd /etc/fail2ban/action.d
|
||||||
|
cat iptables-common.conf > iptables-common-forward.conf
|
||||||
Additionally, a fourth volume must be declared on the **acme-companion** container to store `acme.sh` configuration and state: `/etc/acme.sh`.
|
sed -i 's/INPUT/FORWARD/g' iptables-common-forward.conf
|
||||||
|
|
||||||
Please also read the doc about [data persistence](./docs/Persistent-data.md).
|
cat iptables-multiport.conf > iptables-multiport-forward.conf
|
||||||
|
sed -i 's/iptables-common.conf/iptables-common-forward.conf/g' iptables-multiport-forward.conf
|
||||||
Example of use:
|
|
||||||
|
Restart fai2ban and verify (systemctl status fail2ban)
|
||||||
### Step 1 - nginx-proxy
|
|
||||||
|
|
||||||
Start **nginx-proxy** with the three additional volumes declared:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ docker run --detach \
|
|
||||||
--name nginx-proxy \
|
[](https://github.com/nginx-proxy/acme-companion/releases)
|
||||||
--publish 80:80 \
|
[](https://hub.docker.com/r/nginxproxy/acme-companion "Click to view the image on Docker Hub")
|
||||||
--publish 443:443 \
|
[](https://hub.docker.com/r/nginxproxy/acme-companion "Click to view the image on Docker Hub")
|
||||||
--volume certs:/etc/nginx/certs \
|
[](https://hub.docker.com/r/nginxproxy/acme-companion "Click to view the image on Docker Hub")
|
||||||
--volume vhost:/etc/nginx/vhost.d \
|
|
||||||
--volume html:/usr/share/nginx/html \
|
**acme-companion** is a lightweight companion container for [**nginx-proxy**](https://github.com/nginx-proxy/nginx-proxy).
|
||||||
--volume /var/run/docker.sock:/tmp/docker.sock:ro \
|
|
||||||
nginxproxy/nginx-proxy
|
It handles the automated creation, renewal and use of SSL certificates for proxied Docker containers through the ACME protocol.
|
||||||
```
|
|
||||||
|
**Required read if you use the `latest` version** : the `v2.0.0` release of this project mark the switch of the ACME client used by the Docker image from [**simp.le**](https://github.com/zenhack/simp_le) to [**acme.sh**](https://github.com/acmesh-official/acme.sh). This switch result in some backward incompatible changes, so please read [this issue](https://github.com/nginx-proxy/acme-companion/issues/510) and the updated docs for more details before updating your image. The single most important change is that the container now requires a volume mounted to `/etc/acme.sh` in order to persist ACME account keys and SSL certificates. The last tagged version that uses **simp_le** is `v1.13.1`.
|
||||||
Binding the host docker socket (`/var/run/docker.sock`) inside the container to `/tmp/docker.sock` is a requirement of **nginx-proxy**.
|
|
||||||
|
### Features:
|
||||||
### Step 2 - acme-companion
|
* Automated creation/renewal of Let's Encrypt (or other ACME CAs) certificates using [**acme.sh**](https://github.com/acmesh-official/acme.sh).
|
||||||
|
* Let's Encrypt / ACME domain validation through `http-01` challenge only.
|
||||||
Start the **acme-companion** container, getting the volumes from **nginx-proxy** with `--volumes-from`:
|
* Automated update and reload of nginx config on certificate creation/renewal.
|
||||||
|
* Support creation of [Multi-Domain (SAN) Certificates](https://github.com/nginx-proxy/acme-companion/blob/main/docs/Let's-Encrypt-and-ACME.md#multi-domains-certificates).
|
||||||
```shell
|
* Creation of a Strong Diffie-Hellman Group at startup.
|
||||||
$ docker run --detach \
|
* Work with all versions of docker.
|
||||||
--name nginx-proxy-acme \
|
|
||||||
--volumes-from nginx-proxy \
|
### Requirements:
|
||||||
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
|
* Your host **must** be publicly reachable on **both** port `80` and `443`.
|
||||||
--volume acme:/etc/acme.sh \
|
* Check your firewall rules and **do not attempt to block port `80`** as that will prevent `http-01` challenges from completing.
|
||||||
--env "DEFAULT_EMAIL=mail@yourdomain.tld" \
|
* For the same reason, you can't use nginx-proxy's [`HTTPS_METHOD=nohttp`](https://github.com/nginx-proxy/nginx-proxy#how-ssl-support-works).
|
||||||
nginxproxy/acme-companion
|
* The (sub)domains you want to issue certificates for must correctly resolve to the host.
|
||||||
```
|
* Your DNS provider must [answer correctly to CAA record requests](https://letsencrypt.org/docs/caa/).
|
||||||
|
* If your (sub)domains have AAAA records set, the host must be publicly reachable over IPv6 on port `80` and `443`.
|
||||||
The host docker socket has to be bound inside this container too, this time to `/var/run/docker.sock`.
|
|
||||||
|
|
||||||
Albeit **optional**, it is **recommended** to provide a valid default email address through the `DEFAULT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
|
|
||||||
|
## Basic usage (with the nginx-proxy container)
|
||||||
### Step 3 - proxied container(s)
|
|
||||||
|
Three writable volumes must be declared on the **nginx-proxy** container so that they can be shared with the **acme-companion** container:
|
||||||
Once both **nginx-proxy** and **acme-companion** containers are up and running, start any container you want proxied with environment variables `VIRTUAL_HOST` and `LETSENCRYPT_HOST` both set to the domain(s) your proxied container is going to use.
|
|
||||||
|
* `/etc/nginx/certs` to store certificates and private keys (readonly for the **nginx-proxy** container).
|
||||||
[`VIRTUAL_HOST`](https://github.com/nginx-proxy/nginx-proxy#usage) control proxying by **nginx-proxy** and `LETSENCRYPT_HOST` control certificate creation and SSL enabling by **acme-companion**.
|
* `/etc/nginx/vhost.d` to change the configuration of vhosts (required so the CA may access `http-01` challenge files).
|
||||||
|
* `/usr/share/nginx/html` to write `http-01` challenge files.
|
||||||
Certificates will only be issued for containers that have both `VIRTUAL_HOST` and `LETSENCRYPT_HOST` variables set to domain(s) that correctly resolve to the host, provided the host is publicly reachable.
|
|
||||||
|
Additionally, a fourth volume must be declared on the **acme-companion** container to store `acme.sh` configuration and state: `/etc/acme.sh`.
|
||||||
```shell
|
|
||||||
$ docker run --detach \
|
Please also read the doc about [data persistence](./docs/Persistent-data.md).
|
||||||
--name your-proxied-app \
|
|
||||||
--env "VIRTUAL_HOST=subdomain.yourdomain.tld" \
|
Example of use:
|
||||||
--env "LETSENCRYPT_HOST=subdomain.yourdomain.tld" \
|
|
||||||
nginx
|
### Step 1 - nginx-proxy
|
||||||
```
|
|
||||||
|
Start **nginx-proxy** with the three additional volumes declared:
|
||||||
The containers being proxied must expose the port to be proxied, either by using the `EXPOSE` directive in their Dockerfile or by using the `--expose` flag to `docker run` or `docker create`.
|
|
||||||
|
```shell
|
||||||
If the proxied container listen on and expose another port than the default `80`, you can force **nginx-proxy** to use this port with the [`VIRTUAL_PORT`](https://github.com/nginx-proxy/nginx-proxy#multiple-ports) environment variable.
|
$ docker run --detach \
|
||||||
|
--name nginx-proxy \
|
||||||
Example using [Grafana](https://hub.docker.com/r/grafana/grafana/) (expose and listen on port 3000):
|
--publish 80:80 \
|
||||||
|
--publish 443:443 \
|
||||||
```shell
|
--volume certs:/etc/nginx/certs \
|
||||||
$ docker run --detach \
|
--volume vhost:/etc/nginx/vhost.d \
|
||||||
--name grafana \
|
--volume html:/usr/share/nginx/html \
|
||||||
--env "VIRTUAL_HOST=othersubdomain.yourdomain.tld" \
|
--volume /var/run/docker.sock:/tmp/docker.sock:ro \
|
||||||
--env "VIRTUAL_PORT=3000" \
|
nginxproxy/nginx-proxy
|
||||||
--env "LETSENCRYPT_HOST=othersubdomain.yourdomain.tld" \
|
```
|
||||||
--env "LETSENCRYPT_EMAIL=mail@yourdomain.tld" \
|
|
||||||
grafana/grafana
|
Binding the host docker socket (`/var/run/docker.sock`) inside the container to `/tmp/docker.sock` is a requirement of **nginx-proxy**.
|
||||||
```
|
|
||||||
|
### Step 2 - acme-companion
|
||||||
Repeat [Step 3](#step-3---proxied-containers) for any other container you want to proxy.
|
|
||||||
|
Start the **acme-companion** container, getting the volumes from **nginx-proxy** with `--volumes-from`:
|
||||||
## Additional documentation
|
|
||||||
|
```shell
|
||||||
Please check the [docs section](https://github.com/nginx-proxy/acme-companion/tree/main/docs).
|
$ docker run --detach \
|
||||||
|
--name nginx-proxy-acme \
|
||||||
|
--volumes-from nginx-proxy \
|
||||||
|
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
|
||||||
|
--volume acme:/etc/acme.sh \
|
||||||
|
--env "DEFAULT_EMAIL=mail@yourdomain.tld" \
|
||||||
|
nginxproxy/acme-companion
|
||||||
|
```
|
||||||
|
|
||||||
|
The host docker socket has to be bound inside this container too, this time to `/var/run/docker.sock`.
|
||||||
|
|
||||||
|
Albeit **optional**, it is **recommended** to provide a valid default email address through the `DEFAULT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
|
||||||
|
|
||||||
|
### Step 3 - proxied container(s)
|
||||||
|
|
||||||
|
Once both **nginx-proxy** and **acme-companion** containers are up and running, start any container you want proxied with environment variables `VIRTUAL_HOST` and `LETSENCRYPT_HOST` both set to the domain(s) your proxied container is going to use.
|
||||||
|
|
||||||
|
[`VIRTUAL_HOST`](https://github.com/nginx-proxy/nginx-proxy#usage) control proxying by **nginx-proxy** and `LETSENCRYPT_HOST` control certificate creation and SSL enabling by **acme-companion**.
|
||||||
|
|
||||||
|
Certificates will only be issued for containers that have both `VIRTUAL_HOST` and `LETSENCRYPT_HOST` variables set to domain(s) that correctly resolve to the host, provided the host is publicly reachable.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ docker run --detach \
|
||||||
|
--name your-proxied-app \
|
||||||
|
--env "VIRTUAL_HOST=subdomain.yourdomain.tld" \
|
||||||
|
--env "LETSENCRYPT_HOST=subdomain.yourdomain.tld" \
|
||||||
|
nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
The containers being proxied must expose the port to be proxied, either by using the `EXPOSE` directive in their Dockerfile or by using the `--expose` flag to `docker run` or `docker create`.
|
||||||
|
|
||||||
|
If the proxied container listen on and expose another port than the default `80`, you can force **nginx-proxy** to use this port with the [`VIRTUAL_PORT`](https://github.com/nginx-proxy/nginx-proxy#multiple-ports) environment variable.
|
||||||
|
|
||||||
|
Example using [Grafana](https://hub.docker.com/r/grafana/grafana/) (expose and listen on port 3000):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ docker run --detach \
|
||||||
|
--name grafana \
|
||||||
|
--env "VIRTUAL_HOST=othersubdomain.yourdomain.tld" \
|
||||||
|
--env "VIRTUAL_PORT=3000" \
|
||||||
|
--env "LETSENCRYPT_HOST=othersubdomain.yourdomain.tld" \
|
||||||
|
--env "LETSENCRYPT_EMAIL=mail@yourdomain.tld" \
|
||||||
|
grafana/grafana
|
||||||
|
```
|
||||||
|
|
||||||
|
Repeat [Step 3](#step-3---proxied-containers) for any other container you want to proxy.
|
||||||
|
|
||||||
|
## Additional documentation
|
||||||
|
|
||||||
|
Please check the [docs section](https://github.com/nginx-proxy/acme-companion/tree/main/docs).
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user