admin/frappe_docker
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

Use docker compose instead of docker-compose (#1702)

Browse Source 
* Use `docker compose` instead of `docker-compose`

Update to use new docker syntax.

* use `docker` instead of `docker-compose`
This commit is contained in:
MeIchthys
2025-09-13 02:54:41 -04:00
committed by GitHub
parent 6e78467603
commit 2f5a42d864
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/site-operations.md
View File

@@ -1,16 +1,16 @@
# Site operations # Site operations
> 💡 You should setup `--project-name` option in `docker-compose` commands if you have non-standard project name. > 💡 You should setup `--project-name` option in `docker` commands if you have non-standard project name.
## Setup new site ## Setup new site
Note: Note:
- Wait for the `db` service to start and `configurator` to exit before trying to create a new site. Usually this takes up to 10 seconds. - Wait for the `db` service to start and `configurator` to exit before trying to create a new site. Usually this takes up to 10 seconds.
- Also you have to pass `-p <project_name>` if `-p` passed previously eg. `docker-compose -p <project_name> exec (rest of the command)`. - Also you have to pass `-p <project_name>` if `-p` passed previously eg. `docker -p <project_name> exec (rest of the command)`.
```sh ```sh
docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --db-root-password <db-password> --admin-password <admin-password> <site-name> docker exec backend bench new-site --mariadb-user-host-login-scope=% --db-root-password <db-password> --admin-password <admin-password> <site-name>
``` ```
If you need to install some app, specify `--install-app`. To see all options, just run `bench new-site --help`. If you need to install some app, specify `--install-app`. To see all options, just run `bench new-site --help`.
@@ -18,14 +18,14 @@ If you need to install some app, specify `--install-app`. To see all options, ju
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](images-and-compose-files.md#overrides)) you need have to do set `root_login` and `root_password` in common config before that:
```sh ```sh
docker-compose exec backend bench set-config -g root_login <root-login> docker exec backend bench set-config -g root_login <root-login>
docker-compose exec backend bench set-config -g root_password <root-password> docker exec backend bench set-config -g root_password <root-password>
``` ```
Also command is slightly different: Also command is slightly different:
```sh ```sh
docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --db-type postgres --admin-password <admin-password> <site-name> docker exec backend bench new-site --mariadb-user-host-login-scope=% --db-type postgres --admin-password <admin-password> <site-name>
``` ```
## Push backup to S3 storage ## Push backup to S3 storage
@@ -33,7 +33,7 @@ docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --d
We have the script that helps to push latest backup to S3. We have the script that helps to push latest backup to S3.
```sh ```sh
docker-compose exec backend push_backup.py --site-name <site-name> --bucket <bucket> --region-name <region> --endpoint-url <endpoint-url> --aws-access-key-id <access-key> --aws-secret-access-key <secret-key> docker exec backend push_backup.py --site-name <site-name> --bucket <bucket> --region-name <region> --endpoint-url <endpoint-url> --aws-access-key-id <access-key> --aws-secret-access-key <secret-key>
``` ```
Note that you can restore backup only manually. Note that you can restore backup only manually.
@@ -59,7 +59,7 @@ Instead of `alpine` use any image of your choice.
For socketio and gunicorn service ping the hostname:port and that will be sufficient. For workers and scheduler, there is a command that needs to be executed. For socketio and gunicorn service ping the hostname:port and that will be sufficient. For workers and scheduler, there is a command that needs to be executed.
```shell ```shell
docker-compose exec backend healthcheck.sh --ping-service mongodb:27017 docker exec backend healthcheck.sh --ping-service mongodb:27017
``` ```
Additional services can be pinged as part of health check with option `-p` or `--ping-service`. Additional services can be pinged as part of health check with option `-p` or `--ping-service`.
@@ -72,7 +72,7 @@ If connection to service(s) fails, the command fails with exit code 1.
For reference of commands like `backup`, `drop-site` or `migrate` check [official guide](https://frappeframework.com/docs/v13/user/en/bench/frappe-commands) or run: For reference of commands like `backup`, `drop-site` or `migrate` check [official guide](https://frappeframework.com/docs/v13/user/en/bench/frappe-commands) or run:
```sh ```sh
docker-compose exec backend bench --help docker exec backend bench --help
``` ```
## Migrate site ## Migrate site
@@ -82,5 +82,5 @@ Note:
- Wait for the `db` service to start and `configurator` to exit before trying to migrate a site. Usually this takes up to 10 seconds. - Wait for the `db` service to start and `configurator` to exit before trying to migrate a site. Usually this takes up to 10 seconds.
```sh ```sh
docker-compose exec backend bench --site <site-name> migrate docker exec backend bench --site <site-name> migrate
``` ```