Merge pull request #453 from padloc/fix/deploy-docs

Fix deploy/example docs
This commit is contained in:
Bruno Bernardino 2022-06-03 15:58:51 +01:00 committed by GitHub
commit 4fa5b96db2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 11 deletions

View File

@ -1,26 +1,27 @@
# Docker + Postgres + NGINX + Letsencrypt
# Docker + PostgreSQL + NGINX + Let's Encrypt
This is a more advanced example of running an instance of the Padloc server
component and web app with [Docker](https://www.docker.com/) and
[Docker Compose](https://docs.docker.com/compose/), using:
- [PostgreSQL](https://www.postgresql.org/) as the datababase backend
- [PostgreSQL](https://www.postgresql.org/) as the datababase backend.
- [NGINX](https://www.nginx.com/) as a reverse proxy.
- [Letsencrypt](https://letsencrypt.org/) for obtaining a TLS certificate.
- [Let's Encrypt](https://letsencrypt.org/) for obtaining a TLS certificate.
## Setup Instructions
0. Install [Docker](https://docs.docker.com/get-docker/) and
[Docker Compose](https://docs.docker.com/compose/install/)
[Docker Compose](https://docs.docker.com/compose/install/).
1. Clone or download this folder and `cd` into it.
2. Edit the `.env` file to set your STMP settings, Postgres database name,
2. Edit the `.env` file to set your STMP settings, PostgreSQL database name,
username and password, and the host name / domain you want to host the web
app and server under.
3. Obtain an TLS certificate
3. Edit the `get-cert.sh` file to set your correct host name / domain and email,
then obtain a TLS certificate:
```sh
docker-compose up cerbot
chmod +x ./get-cert.sh && ./get-cert.sh
```
4. Start the server, pwa, database and reverse proxy:
@ -33,11 +34,12 @@ That's it! The web app is now available at `https://$PL_HOSTNAME`
## Renewing the TLS certificate
TLS certificates issued by Letsencrypt are usually valid for 90 days, so you'll
have to regularly renew your certificate. To do so, simply run the following:
TLS certificates issued by Let's Encrypt are usually valid for 90 days, so
you'll have to regularly renew your certificate. To do so, simply run the
following:
```sh
docker-compose down && \
docker-compose up certbot && \
./get-cert.sh && \
docker-compose up -d
```

View File

@ -3,4 +3,4 @@ sudo docker run --rm --name certbot -p 80:80 \
-v "/var/lib/letsencrypt:/var/lib/letsencrypt" \
certbot/certbot certonly --standalone \
-d test.padloc.app \
--expand --non-interactive --agree-tos -m martin@pentacode.app
--expand --non-interactive --agree-tos -m martin@padloc.app