Skip to content

Commit

Permalink
Merge pull request #1171 from free-ghz/main
Browse files Browse the repository at this point in the history
docs: specify correct amount of volumes
  • Loading branch information
buchdag authored Dec 9, 2024
2 parents 690f959 + 9e047c9 commit ea11f22
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,20 @@ In addition to the above, please ensure that your DNS provider answers correctly

## Basic usage (with the nginx-proxy container)

Three writable volumes must be declared on the **nginx-proxy** container so that they can be shared with the **acme-companion** container:
Two writable volumes must be declared on the **nginx-proxy** container so that they can be shared with the **acme-companion** container:

* `/etc/nginx/certs` to store certificates and private keys (readonly for the **nginx-proxy** container).
* `/usr/share/nginx/html` to write `http-01` challenge files.

Additionally, a fourth volume must be declared on the **acme-companion** container to store `acme.sh` configuration and state: `/etc/acme.sh`.
Additionally, a third volume must be declared on the **acme-companion** container to store `acme.sh` configuration and state: `/etc/acme.sh`.

Please also read the doc about [data persistence](./docs/Persistent-data.md).

Example of use:

### Step 1 - nginx-proxy

Start **nginx-proxy** with the three additional volumes declared:
Start **nginx-proxy** with the two additional volumes declared:

```shell
$ docker run --detach \
Expand Down
4 changes: 2 additions & 2 deletions docs/Basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Two writable volumes must be declared on the **nginx-proxy** container so that t
* `/etc/nginx/certs` to store certificates and private keys (readonly for the **nginx-proxy** container).
* `/usr/share/nginx/html` to write `HTTP-01` challenge files.

Additionally, a fourth volume must be declared on the **acme-companion** container to store `acme.sh` configuration and state: `/etc/acme.sh`.
Additionally, a third volume must be declared on the **acme-companion** container to store `acme.sh` configuration and state: `/etc/acme.sh`.

Please also read the doc about [data persistence](./Persistent-data.md).

Example of use:

### Step 1 - nginx-proxy

Start **nginx-proxy** with the three additional volumes declared:
Start **nginx-proxy** with the two additional volumes declared:

```shell
$ docker run --detach \
Expand Down

0 comments on commit ea11f22

Please sign in to comment.