mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-17 13:55:08 +00:00
09934d576c
* docs: reorganize documentation structure into logical categories Restructure documentation into organized directories for better navigation: - getting-started/: Quick start guides for new users - setup/: Setup and configuration guides - production/: Production deployment guides (backup, TLS, multi-tenancy) - operations/: Site operations and management - development/: Development workflow guides - migration/: Migration guides - troubleshooting/: Troubleshooting guides - reference/: Reference documentation (container setup, build configs) Rename files for consistency: - Use kebab-case naming convention throughout - Remove numbered prefixes from container-setup files - Use descriptive names (backup-strategy, tls-ssl-setup, etc.) Update all internal cross-references to reflect new file locations. Update README.md with organized documentation structure. Fix image paths in development.md to use correct relative paths. * docs: add numeric prefixes to directories and files for navigation order Add numeric prefixes (01-08) to documentation directories to indicate reading order and flow for first-time users: - 01-getting-started: Quick start guides - 02-setup: Setup and configuration - 03-production: Production deployment - 04-operations: Site operations - 05-development: Development guides - 06-migration: Migration guides - 07-troubleshooting: Troubleshooting - 08-reference: Reference documentation Add numeric prefixes to files within directories to guide readers through documentation in a logical sequence. Update all cross-references throughout documentation to use new numbered paths. Update README.md to reflect the new structure. * docs: move container-setup to 02-setup and integrate setup-options content Move container-setup directory from 08-reference/ to 02-setup/ to follow PR feedback. The container-setup documentation provides a more linear and coherent flow compared to the previous unstructured setup files. Changes: - Move container-setup/ from docs/08-reference/ to docs/02-setup/ - Integrate content from setup-options.md into structured flow: - Create new 06-setup-examples.md with practical deployment scenarios - Enhance 03-start-setup.md with site creation details from setup-options - Remove redundant 01-setup-options.md (content now integrated) - Rename 02-single-server-example.md to 07-single-server-example.md - Update all cross-references throughout documentation: - Update README.md with new structure under Setup section - Fix links in site-operations.md and migration docs - Add navigation links between container-setup files and examples - Maintain container-setup's linear flow: overview → build → start → env → overrides - Add practical examples document (06-setup-examples.md) that follows the container-setup guide Result: Documentation now follows a clear progression from conceptual overview through practical examples, with all setup information properly organized under 02-setup/. * docs: remove container-setup subfolder and flatten structure Move all files from docs/02-setup/container-setup/ directly into docs/02-setup/ to eliminate unnecessary subfolder. Files are already numbered sequentially, so they work perfectly at the same level. Changes: - Move all files from container-setup/ subfolder to 02-setup/ root - Remove container-setup/ subfolder - Update all cross-references: - Update README.md paths (remove container-setup/ from all links) - Fix references in site-operations.md - Fix references in migration docs - Update internal references in 06-setup-examples.md - Fix relative path references in 01-overview.md, 02-build-setup.md, 03-start-setup.md Result: Cleaner, flatter structure with all numbered setup files at the same level, making navigation more straightforward. * fix: Pre-commit failure is fixed --------- Co-authored-by: adithya <adithya.a@bayesian.in>
58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
Create backup service or stack.
|
|
|
|
```yaml
|
|
# backup-job.yml
|
|
version: "3.7"
|
|
services:
|
|
backup:
|
|
image: frappe/erpnext:${VERSION}
|
|
entrypoint: ["bash", "-c"]
|
|
command:
|
|
- |
|
|
bench --site all backup
|
|
## Uncomment for restic snapshots.
|
|
# restic snapshots || restic init
|
|
# restic backup sites
|
|
## Uncomment to keep only last n=30 snapshots.
|
|
# restic forget --group-by=paths --keep-last=30 --prune
|
|
environment:
|
|
# Set correct environment variables for restic
|
|
- RESTIC_REPOSITORY=s3:https://s3.endpoint.com/restic
|
|
- AWS_ACCESS_KEY_ID=access_key
|
|
- AWS_SECRET_ACCESS_KEY=secret_access_key
|
|
- RESTIC_PASSWORD=restic_password
|
|
volumes:
|
|
- "sites:/home/frappe/frappe-bench/sites"
|
|
networks:
|
|
- erpnext-network
|
|
|
|
networks:
|
|
erpnext-network:
|
|
external: true
|
|
name: ${PROJECT_NAME:-erpnext}_default
|
|
|
|
volumes:
|
|
sites:
|
|
external: true
|
|
name: ${PROJECT_NAME:-erpnext}_sites
|
|
```
|
|
|
|
In case of single docker host setup, add crontab entry for backup every 6 hours.
|
|
|
|
```
|
|
0 */6 * * * /usr/local/bin/docker-compose -f /path/to/backup-job.yml up -d > /dev/null
|
|
```
|
|
|
|
Or
|
|
|
|
```
|
|
0 */6 * * * docker compose -p erpnext exec backend bench --site all backup --with-files > /dev/null
|
|
```
|
|
|
|
Notes:
|
|
|
|
- Make sure `docker-compose` or `docker compose` is available in path during execution.
|
|
- Change the cron string as per need.
|
|
- Set the correct project name in place of `erpnext`.
|
|
- For Docker Swarm add it as a [swarm-cronjob](https://github.com/crazy-max/swarm-cronjob)
|
|
- Add it as a `CronJob` in case of Kubernetes cluster.
|