docs: update README

This commit is contained in:
Jayden Pyles
2024-06-26 20:23:00 -05:00
parent 0c4d60d4cd
commit a24a626cbb

View File

@@ -30,6 +30,8 @@ Utilizes Github Actions and Ansible to build Docker images to quickly deploy ont
- `deploy_path`: Path where to clone the repo to on the server - `deploy_path`: Path where to clone the repo to on the server
- `deploy_command`: `Make` command to run to deploy on the server - `deploy_command`: `Make` command to run to deploy on the server
- Add your domain in HOSTNAME_PROD in the `Makefile`
## Deployment ## Deployment
### Local Deployment ### Local Deployment
@@ -54,3 +56,13 @@ Easy deployment using `make setup deploy` after completing the required config f
- `setup`: Install dependencies and clone repo onto server - `setup`: Install dependencies and clone repo onto server
- `deploy`: Deploy on server - `deploy`: Deploy on server
To use a SSL certificate, uncomment the volumes under the `traefik` service. Add your own certificates for use in Traefik.
```yaml
volumes:
- "/var/run/docker.sock:/var/run/docker.sock:ro"
- "./dynamic_conf.yaml:/etc/traefik/dynamic_conf.yaml"
- "/etc/letsencrypt/live/domain/fullchain.pem:/etc/certs/ssl-cert.pem"
- "/etc/letsencrypt/live/domain/privkey.pem:/etc/certs/ssl-cert.key"
```