epistemophiliac/frappe_docker
1
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2026-06-17 13:55:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

chore: run pre-commit fixes

Browse source
This commit is contained in:
RocketQuack 2026-01-19 19:31:55 +01:00
parent c5525bf021
commit 80a11fb47f
7 changed files with 161 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/02-setup/04-env-variables.md
View file

@ -46,7 +46,7 @@ Then edit `.env` and set variables according to your needs.
## HTTPS & SSL Configuration
| Variable | Purpose | Default | When to Set |
| ------------------- | ------------------------------------------------ | ------- | ---------------------------------------- |
| ------------------- | ------------------------------------------------------------- | ------- | ---------------------------------------- |
| `LETSENCRYPT_EMAIL` | Email for Let's Encrypt certificate registration | — | Required if using HTTPS override |
| `SITES_RULE` | List of domains for SSL (Traefik rule for TLS domain routing) | — | Required if using reverse proxy override |

2
docs/02-setup/05-overrides.md
View file

@ -5,7 +5,7 @@ docker compose -f compose.yaml -f overrides/compose.mariadb.yaml -f overrides/co
```
| Overrider | Purpose | Additional Info |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| **Database** | | |
| compose.mariadb.yaml | Adds MariaDB database service | set `DB_PASSWORD` or default Password will be used |
| compose.mariadb-secrets.yaml | Adds MariaDB with password from a secret file instead of environment variable | Set `DB_PASSWORD_SECRETS_FILE` to the path of your secret file |

18
docs/06-migration/02-traefik-v3-migration.md
View file

@ -3,24 +3,27 @@
Use this guide if you already run Traefik v2 with `frappe_docker` and want to upgrade to v3. It focuses on the image upgrade and the v3 routing rule changes that affect existing setups.
### Before you start
Before migrating anything, it is always recommended to create a backup. Better safe than sorry. In particular, compose and .env should be backed up.
### Quick upgrade summary
1) Pull the updated repo
2) Update env variables especially the updated `SITES` to `SITES_RULE`
3) Regenerate the compose config and restart the stack
1. Pull the updated repo
2. Update env variables especially the updated `SITES` to `SITES_RULE`
3. Regenerate the compose config and restart the stack
#### Multiple hostnames
v2 allowed comma-separated host lists inside `Host(...)`. In v3 traefik uses logical OR
**Before (v2):**
```
Host(`a.example.com`,`b.example.com`)
```
**After (v3):**
```
Host(`a.example.com`) || Host(`b.example.com`)
```
@ -30,11 +33,13 @@ Host(`a.example.com`) || Host(`b.example.com`)
All Traefik routing for HTTPS and multi-bench setups now uses `SITES_RULE`, which is a full v3 rule expression
**Single site:**
```
SITES_RULE=Host(`erp.example.com`)
```
**Multiple sites:**
```
SITES_RULE=Host(`a.example.com`) || Host(`b.example.com`)
```
@ -51,6 +56,7 @@ docker compose --env-file .env \
-f overrides/compose.https.yaml \
config > ~/gitops/docker-compose.yml
```
```sh
docker compose --project-name <project-name> -f ~/gitops/docker-compose.yml up -d
```
@ -65,6 +71,6 @@ After restarting, Traefik will be used in the new supported version 3.6 and the
If you need to rollback:
1) Revert Traefik image to `v2.11`
2) Restore the old `SITES` variable format and v2 rules
3) Regenerate the compose config and restart
1. Revert Traefik image to `v2.11`
2. Restore the old `SITES` variable format and v2 rules
3. Regenerate the compose config and restart