mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 06:05:09 +00:00
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.
This commit is contained in:
parent
e7db934767
commit
a2c0134c05
21 changed files with 49 additions and 31 deletions
54
README.md
54
README.md
|
|
@ -55,32 +55,50 @@ If you ran in a Dev Docker environment, to view container logs: `docker compose
|
|||
|
||||
### [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions)
|
||||
|
||||
### [Getting Started](#getting-started)
|
||||
|
||||
- [Quick Start (Linux/Mac)](docs/getting-started/quick-start-linux-mac.md)
|
||||
- [Single Compose Setup](docs/getting-started/single-compose-setup.md)
|
||||
|
||||
### [Setup](#setup)
|
||||
|
||||
- [Container Overview](docs/reference/container-setup/overview.md)
|
||||
- [Setup Options](docs/setup/setup-options.md)
|
||||
- [Single Server Example](docs/setup/single-server-example.md)
|
||||
|
||||
### [Production](#production)
|
||||
|
||||
- [List of containers](docs/container-setup/01-overview.md)
|
||||
- [Single Compose Setup](docs/single-compose-setup.md)
|
||||
- [Environment Variables](docs/container-setup/env-variables.md)
|
||||
- [Single Server Example](docs/single-server-example.md)
|
||||
- [Setup Options](docs/setup-options.md)
|
||||
- [Site Operations](docs/site-operations.md)
|
||||
- [Backup and Push Cron Job](docs/backup-and-push-cronjob.md)
|
||||
- [Port Based Multi Tenancy](docs/port-based-multi-tenancy.md)
|
||||
- [Migrate from multi-image setup](docs/migrate-from-multi-image-setup.md)
|
||||
- [running on linux/mac](docs/setup_for_linux_mac.md)
|
||||
- [TLS for local deployment](docs/tls-for-local-deployment.md)
|
||||
- [TLS/SSL Setup](docs/production/tls-ssl-setup.md)
|
||||
- [Backup Strategy](docs/production/backup-strategy.md)
|
||||
- [Multi-Tenancy](docs/production/multi-tenancy.md)
|
||||
|
||||
### [Custom Images](#custom-images)
|
||||
### [Operations](#operations)
|
||||
|
||||
- [Custom Apps](docs/container-setup/02-build-setup.md)
|
||||
- [Build Version 10 Images](docs/build-version-10-images.md)
|
||||
- [Site Operations](docs/operations/site-operations.md)
|
||||
|
||||
### [Development](#development)
|
||||
|
||||
- [Development using containers](docs/development.md)
|
||||
- [Bench Console and VSCode Debugger](docs/bench-console-and-vscode-debugger.md)
|
||||
- [Connect to localhost services](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
|
||||
- [Development Guide](docs/development/development.md)
|
||||
- [Debugging](docs/development/debugging.md)
|
||||
- [Local Services Connection](docs/development/local-services-connection.md)
|
||||
|
||||
### [Troubleshoot](docs/troubleshoot.md)
|
||||
### [Migration](#migration)
|
||||
|
||||
- [Migrate from Multi-Image Setup](docs/migration/migrate-from-multi-image-setup.md)
|
||||
|
||||
### [Troubleshooting](#troubleshooting)
|
||||
|
||||
- [Troubleshoot Guide](docs/troubleshooting/troubleshoot.md)
|
||||
- [Windows Nginx Entrypoint Error](docs/troubleshooting/windows-nginx-entrypoint-error.md)
|
||||
|
||||
### [Reference](#reference)
|
||||
|
||||
- [Container Setup Overview](docs/reference/container-setup/overview.md)
|
||||
- [Build Setup](docs/reference/container-setup/build-setup.md)
|
||||
- [Start Setup](docs/reference/container-setup/start-setup.md)
|
||||
- [Environment Variables](docs/reference/container-setup/env-variables.md)
|
||||
- [Compose Overrides](docs/reference/container-setup/overrides.md)
|
||||
- [Build Version 10 Images](docs/reference/build-version-10-images.md)
|
||||
|
||||
# Contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -14,9 +14,9 @@ It is recommended you allocate at least 4GB of RAM to docker:
|
|||
- [Instructions for macOS](https://docs.docker.com/desktop/settings/mac/#advanced)
|
||||
|
||||
Here is a screenshot showing the relevant setting in the Help Manual
|
||||

|
||||

|
||||
Here is a screenshot showing the settings in Docker Desktop on Mac
|
||||

|
||||

|
||||
|
||||
## Bootstrap Containers for development
|
||||
|
||||
|
|
@ -6,7 +6,7 @@ Now you need to specify command and environment variables for following containe
|
|||
|
||||
### Frontend
|
||||
|
||||
For `frontend` service to act as static assets frontend and reverse proxy, you need to pass `nginx-entrypoint.sh` as container `command` and `BACKEND` and `SOCKETIO` environment variables pointing `{host}:{port}` for gunicorn and websocket services. Check [environment variables](environment-variables.md)
|
||||
For `frontend` service to act as static assets frontend and reverse proxy, you need to pass `nginx-entrypoint.sh` as container `command` and `BACKEND` and `SOCKETIO` environment variables pointing `{host}:{port}` for gunicorn and websocket services. Check [environment variables](../reference/container-setup/env-variables.md)
|
||||
|
||||
Now you only need to mount the `sites` volume at location `/home/frappe/frappe-bench/sites`. No need for `assets` volume and asset population script or steps.
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --d
|
|||
|
||||
If you need to install some app, specify `--install-app`. To see all options, just run `bench new-site --help`.
|
||||
|
||||
To create Postgres site (assuming you already use [Postgres compose override](images-and-compose-files.md#overrides)) you need have to do set `root_login` and `root_password` in common config before that:
|
||||
To create Postgres site (assuming you already use [Postgres compose override](../reference/container-setup/overrides.md)) you need have to do set `root_login` and `root_password` in common config before that:
|
||||
|
||||
```sh
|
||||
docker-compose exec backend bench set-config -g root_login <root-login>
|
||||
|
|
@ -116,6 +116,6 @@ This generates `compose.custom.yaml`, which you'll use to start all containers.
|
|||
|
||||
---
|
||||
|
||||
**Next:** [Start Setup →](03-start-setup.md)
|
||||
**Next:** [Start Setup →](start-setup.md)
|
||||
|
||||
**Back:** [Container Overview ←](01-overview.md)
|
||||
**Back:** [Container Overview ←](overview.md)
|
||||
|
|
@ -40,8 +40,8 @@ Once images are built, containers are orchestrated using a [compose file](https:
|
|||
|
||||
Additional functionality can be added using [overrides](https://docs.docker.com/compose/extends/). These files modify existing services or add new ones without changing the main `compose.yaml`.
|
||||
|
||||
Example: The main compose file has no database service, but `compose.mariadb.yaml` adds MariaDB. See [overrider.md](overrider.md) for the complete list of available overrides and how to use them.
|
||||
Example: The main compose file has no database service, but `compose.mariadb.yaml` adds MariaDB. See [overrides.md](overrides.md) for the complete list of available overrides and how to use them.
|
||||
|
||||
---
|
||||
|
||||
**Next:** [Build Setup →](02-build-setup.md)
|
||||
**Next:** [Build Setup →](build-setup.md)
|
||||
|
|
@ -39,4 +39,4 @@ Replace `<sitename>` with your desired site name.
|
|||
|
||||
---
|
||||
|
||||
**Back:** [Build Setup →](02-build-setup.md)
|
||||
**Back:** [Build Setup →](build-setup.md)
|
||||
|
|
@ -17,7 +17,7 @@ Copy the example docker environment file to `.env`:
|
|||
cp example.env .env
|
||||
```
|
||||
|
||||
Note: To know more about environment variable [read here](./environment-variables.md). Set the necessary variables in the `.env` file.
|
||||
Note: To know more about environment variable [read here](../reference/container-setup/env-variables.md). Set the necessary variables in the `.env` file.
|
||||
|
||||
## Generate docker-compose.yml for variety of setups
|
||||
|
||||
|
|
@ -98,7 +98,7 @@ docker compose --project-name <project-name> -f ~/gitops/docker-compose.yml up -
|
|||
|
||||
## Create first site
|
||||
|
||||
After starting containers, the first site needs to be created. Refer [site operations](./site-operations.md#setup-new-site).
|
||||
After starting containers, the first site needs to be created. Refer [site operations](../operations/site-operations.md#setup-new-site).
|
||||
|
||||
## Updating Images
|
||||
|
||||
|
|
@ -128,4 +128,4 @@ Note:
|
|||
- pull and stop container commands can be skipped if immutable image tags are used
|
||||
- `docker compose up -d` will pull new immutable tags if not found.
|
||||
|
||||
To migrate sites refer [site operations](./site-operations.md#migrate-site)
|
||||
To migrate sites refer [site operations](../operations/site-operations.md#migrate-site)
|
||||
|
|
@ -285,4 +285,4 @@ docker compose --project-name custom-one-example -f ~/gitops/custom-one-example.
|
|||
|
||||
### Site operations
|
||||
|
||||
Refer: [site operations](./site-operations.md)
|
||||
Refer: [site operations](../operations/site-operations.md)
|
||||
Loading…
Reference in a new issue