diff --git a/README.md b/README.md index 6a208926..31fadc04 100644 --- a/README.md +++ b/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 diff --git a/docs/bench-console-and-vscode-debugger.md b/docs/development/debugging.md similarity index 100% rename from docs/bench-console-and-vscode-debugger.md rename to docs/development/debugging.md diff --git a/docs/development.md b/docs/development/development.md similarity index 99% rename from docs/development.md rename to docs/development/development.md index 8bdeb4f8..6ff718e9 100644 --- a/docs/development.md +++ b/docs/development/development.md @@ -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 -![image](images/Docker%20Manual%20Screenshot%20-%20Resources%20section.png) +![image](../images/Docker%20Manual%20Screenshot%20-%20Resources%20section.png) Here is a screenshot showing the settings in Docker Desktop on Mac -![images](images/Docker%20Desktop%20Screenshot%20-%20Resources%20section.png) +![images](../images/Docker%20Desktop%20Screenshot%20-%20Resources%20section.png) ## Bootstrap Containers for development diff --git a/docs/connect-to-localhost-services-from-containers-for-local-app-development.md b/docs/development/local-services-connection.md similarity index 100% rename from docs/connect-to-localhost-services-from-containers-for-local-app-development.md rename to docs/development/local-services-connection.md diff --git a/docs/setup_for_linux_mac.md b/docs/getting-started/quick-start-linux-mac.md similarity index 100% rename from docs/setup_for_linux_mac.md rename to docs/getting-started/quick-start-linux-mac.md diff --git a/docs/single-compose-setup.md b/docs/getting-started/single-compose-setup.md similarity index 100% rename from docs/single-compose-setup.md rename to docs/getting-started/single-compose-setup.md diff --git a/docs/migrate-from-multi-image-setup.md b/docs/migration/migrate-from-multi-image-setup.md similarity index 98% rename from docs/migrate-from-multi-image-setup.md rename to docs/migration/migrate-from-multi-image-setup.md index 0e3c640c..a2997d10 100644 --- a/docs/migrate-from-multi-image-setup.md +++ b/docs/migration/migrate-from-multi-image-setup.md @@ -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. diff --git a/docs/site-operations.md b/docs/operations/site-operations.md similarity index 95% rename from docs/site-operations.md rename to docs/operations/site-operations.md index 550d9bdf..f1c14af5 100644 --- a/docs/site-operations.md +++ b/docs/operations/site-operations.md @@ -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 diff --git a/docs/backup-and-push-cronjob.md b/docs/production/backup-strategy.md similarity index 100% rename from docs/backup-and-push-cronjob.md rename to docs/production/backup-strategy.md diff --git a/docs/port-based-multi-tenancy.md b/docs/production/multi-tenancy.md similarity index 100% rename from docs/port-based-multi-tenancy.md rename to docs/production/multi-tenancy.md diff --git a/docs/tls-for-local-deployment.md b/docs/production/tls-ssl-setup.md similarity index 100% rename from docs/tls-for-local-deployment.md rename to docs/production/tls-ssl-setup.md diff --git a/docs/build-version-10-images.md b/docs/reference/build-version-10-images.md similarity index 100% rename from docs/build-version-10-images.md rename to docs/reference/build-version-10-images.md diff --git a/docs/container-setup/02-build-setup.md b/docs/reference/container-setup/build-setup.md similarity index 97% rename from docs/container-setup/02-build-setup.md rename to docs/reference/container-setup/build-setup.md index 0e3f0e36..7d78d07e 100644 --- a/docs/container-setup/02-build-setup.md +++ b/docs/reference/container-setup/build-setup.md @@ -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) diff --git a/docs/container-setup/env-variables.md b/docs/reference/container-setup/env-variables.md similarity index 100% rename from docs/container-setup/env-variables.md rename to docs/reference/container-setup/env-variables.md diff --git a/docs/container-setup/overrider.md b/docs/reference/container-setup/overrides.md similarity index 100% rename from docs/container-setup/overrider.md rename to docs/reference/container-setup/overrides.md diff --git a/docs/container-setup/01-overview.md b/docs/reference/container-setup/overview.md similarity index 98% rename from docs/container-setup/01-overview.md rename to docs/reference/container-setup/overview.md index ee266886..f79d2287 100644 --- a/docs/container-setup/01-overview.md +++ b/docs/reference/container-setup/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) diff --git a/docs/container-setup/03-start-setup.md b/docs/reference/container-setup/start-setup.md similarity index 97% rename from docs/container-setup/03-start-setup.md rename to docs/reference/container-setup/start-setup.md index e19df758..8c453cf2 100644 --- a/docs/container-setup/03-start-setup.md +++ b/docs/reference/container-setup/start-setup.md @@ -39,4 +39,4 @@ Replace `` with your desired site name. --- -**Back:** [Build Setup →](02-build-setup.md) +**Back:** [Build Setup →](build-setup.md) diff --git a/docs/setup-options.md b/docs/setup/setup-options.md similarity index 92% rename from docs/setup-options.md rename to docs/setup/setup-options.md index 1d49ceea..90dbe82d 100644 --- a/docs/setup-options.md +++ b/docs/setup/setup-options.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 -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) diff --git a/docs/single-server-example.md b/docs/setup/single-server-example.md similarity index 99% rename from docs/single-server-example.md rename to docs/setup/single-server-example.md index 0bb83798..8eea1f1f 100644 --- a/docs/single-server-example.md +++ b/docs/setup/single-server-example.md @@ -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) diff --git a/docs/troubleshoot.md b/docs/troubleshooting/troubleshoot.md similarity index 100% rename from docs/troubleshoot.md rename to docs/troubleshooting/troubleshoot.md diff --git a/docs/error-nginx-entrypoint-windows.md b/docs/troubleshooting/windows-nginx-entrypoint-error.md similarity index 100% rename from docs/error-nginx-entrypoint-windows.md rename to docs/troubleshooting/windows-nginx-entrypoint-error.md