* 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>
* Added overrider to use docker secrets for mariadb password
* typo in overrider file name
* typo in overrider mariadb-secrets
* typo in overriider mariadb-secrets
* Secrets enviroment variable override
* secrets need different enviroment variable name
* no - for env variables
* Updated deprecated MinIO Env Variables
* refactored to be more robust and better error handling
* temprary debugging changes
* Revert "temprary debugging changes"
This reverts commit d01931064d.
* Revert "refactored to be more robust and better error handling"
This reverts commit fe508668a8.
* Revert "Updated deprecated MinIO Env Variables"
This reverts commit 76e66b5262.
* manually added boto3 before running _create_bucket
* lint formatting
Since the password would be parsed in single quote (') the text transformation is no longer needed. This update is based on issue #1002 (Unable to login to Traefik Dashboard even after providing Correct password in Basic Auth.)
Add steps to the database debugging guide to include more possibilities and fix mysql instructions.
Add explanation on the use of certain variables affected by network configuration.
* Decode the Base64-encoded Environment Variable
* add docs to fix nginx-entrypoint.sh: no such file on windows
* Revert "add docs to fix nginx-entrypoint.sh: no such file on windows"
This reverts commit 395d7cfa3f.
* add docs to fix nginx-entrypoint.sh: no such file on windows
* Fix files according to pre-commit hooks
* chore: enhance compose.yaml with variables for customize
* chore: use default blank values for db and redis variables in compose.yaml
* chore: Use env var for HTTP(S) publish ports in overrides
* docs: explain use of environment variables for image customization
* chore: use ERPNEXT_VERSION as default
* docs: fixed spelling errors
* Update custom-apps.md
made document clear to insert custom app to build and resolved error -
"url": "https://user:password@git.example.com/project/repository.git",
to "url": "https://{{ PAT }}@git.example.com/project/repository.git",
* docs: remove comments from shell commands
---------
Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>
* fix: Add gpg and less
Add gpg so backup "bench --site yoursite.com backup --with-files --compress" does not fail if encryption is enabled
Add "less": fixes#1301
* fix: Add gpg and less
Add gpg so backup "bench --site yoursite.com backup --with-files --compress" does not fail if encryption is enabled
Add "less": fixes frappe#1301
* fix: Update documentation
update documentation to resemble current status
* fix: trailing whitespace
---------
Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>
* Clarification on how to use custom image
* chore: fix lint
* refactor: websocket uses also customizable_image
---------
Co-authored-by: Mauricio Vidal <maovidal@users.noreply.github.com>
* docs: single server setup example
* docs: lint single server setup example
* docs: LAN based setup
* docs: fix traefik ssl override
* docs: move data directory to user home
* docs: remove env-file from exec commands
