mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-17 13:55:08 +00:00
chore: run pre-commit fixes
This commit is contained in:
RocketQuack
parent
c5525bf021
commit
80a11fb47f
7 changed files with 161 additions and 155 deletions
|
|
@ -45,10 +45,10 @@ 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 |
|
||||
| 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 |
|
||||
|
||||
**Format for `SITES_RULE`:**
|
||||
|
||||
|
|
|
|||
|
|
@ -4,24 +4,24 @@ Overrides extend the base compose.yaml with additional services or modify existi
|
|||
docker compose -f compose.yaml -f overrides/compose.mariadb.yaml -f overrides/compose.redis.yaml config > compose.custom.yaml
|
||||
```
|
||||
|
||||
| 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 |
|
||||
| compose.mariadb-shared.yaml | Makes MariaDB available on a shared network (mariadb-network) for other services | set `DB_PASSWORD` |
|
||||
| compose.postgres.yaml | Uses PostgreSQL instead of MariaDB as the database | set `DB_PASSWORD` |
|
||||
| **Proxy** | | |
|
||||
| compose.noproxy.yaml | Exposes the application directly on port `:8080` without a reverse proxy | |
|
||||
| compose.proxy.yaml | Uses Traefik as HTTP reverse proxy on port `:80` | You can change the published port by setting `HTTP_PUBLISH_PORT` |
|
||||
| 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 |
|
||||
| compose.mariadb-shared.yaml | Makes MariaDB available on a shared network (mariadb-network) for other services | set `DB_PASSWORD` |
|
||||
| compose.postgres.yaml | Uses PostgreSQL instead of MariaDB as the database | set `DB_PASSWORD` |
|
||||
| **Proxy** | | |
|
||||
| compose.noproxy.yaml | Exposes the application directly on port `:8080` without a reverse proxy | |
|
||||
| compose.proxy.yaml | Uses Traefik as HTTP reverse proxy on port `:80` | You can change the published port by setting `HTTP_PUBLISH_PORT` |
|
||||
| compose.https.yaml | Uses Traefik as HTTPS reverse proxy on Port `:443` with automatic HTTP-to-HTTPS redirect | `SITES_RULE` and `LETSENCRYPT_EMAIL` must be set. `HTTP_PUBLISH_PORT` and `HTTPS_PUBLISH_PORT` can be set. |
|
||||
| **Redis** | | |
|
||||
| **Redis** | | |
|
||||
| compose.redis.yaml | Adds Redis service for caching and background job queuing |
|
||||
| **TBD** | **The following overrides are available but lack documentation. If you use them and understand their purpose, please consider contributing to this documentation.** |
|
||||
| compose.backup-cron.yaml | | |
|
||||
| compose.custom-domain-ssl.yaml | | |
|
||||
| compose.custom-domain.yaml | | |
|
||||
| compose.multi-bench-ssl.yaml | | |
|
||||
| compose.multi-bench.yaml | | |
|
||||
| compose.traefik-ssl.yaml | | |
|
||||
| compose.traefik.yaml | | |
|
||||
| compose.backup-cron.yaml | | |
|
||||
| compose.custom-domain-ssl.yaml | | |
|
||||
| compose.custom-domain.yaml | | |
|
||||
| compose.multi-bench-ssl.yaml | | |
|
||||
| compose.multi-bench.yaml | | |
|
||||
| compose.traefik-ssl.yaml | | |
|
||||
| compose.traefik.yaml | | |
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in a new issue