From 2e99af1a3f8260704be65c49cbdccb8fb7ec2b0a Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Mon, 30 Oct 2023 11:45:55 +0530 Subject: [PATCH] fix: new-site command (#1260) fix command usage and docs fixes issue#1256 --- docs/development.md | 8 ++++---- docs/migrate-from-multi-image-setup.md | 2 +- docs/setup_for_linux_mac.md | 2 +- docs/single-server-example.md | 8 ++++---- docs/site-operations.md | 4 ++-- pwd.yml | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/development.md b/docs/development.md index 8ea203aa..e2c05ace 100644 --- a/docs/development.md +++ b/docs/development.md @@ -140,7 +140,7 @@ sed -i '/redis/d' ./Procfile You can create a new site with the following command: ```shell -bench new-site sitename --no-mariadb-socket +bench new-site --no-mariadb-socket sitename ``` sitename MUST end with .localhost for trying deployments locally. @@ -148,13 +148,13 @@ sitename MUST end with .localhost for trying deployments locally. for example: ```shell -bench new-site development.localhost --no-mariadb-socket +bench new-site --no-mariadb-socket development.localhost ``` The same command can be run non-interactively as well: ```shell -bench new-site development.localhost --mariadb-root-password 123 --admin-password admin --no-mariadb-socket +bench new-site --mariadb-root-password 123 --admin-password admin --no-mariadb-socket development.localhost ``` The command will ask the MariaDB root password. The default root password is `123`. @@ -167,7 +167,7 @@ To setup site with PostgreSQL as database use option `--db-type postgres` and `- Example: ```shell -bench new-site mypgsql.localhost --db-type postgres --db-host postgresql +bench new-site --db-type postgres --db-host postgresql mypgsql.localhost ``` To avoid entering postgresql username and root password, set it in `common_site_config.json`, diff --git a/docs/migrate-from-multi-image-setup.md b/docs/migrate-from-multi-image-setup.md index 093b129b..79072b0d 100644 --- a/docs/migrate-from-multi-image-setup.md +++ b/docs/migrate-from-multi-image-setup.md @@ -106,7 +106,7 @@ create-site: fi done; echo "sites/common_site_config.json found"; - bench new-site frontend --no-mariadb-socket --admin-password=admin --db-root-password=admin --install-app erpnext --set-default; + bench new-site --no-mariadb-socket --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend; # ... removed for brevity ``` diff --git a/docs/setup_for_linux_mac.md b/docs/setup_for_linux_mac.md index b8718fb4..651f67ca 100644 --- a/docs/setup_for_linux_mac.md +++ b/docs/setup_for_linux_mac.md @@ -81,7 +81,7 @@ services: fi done; echo "sites/common_site_config.json found"; - bench new-site frontend --no-mariadb-socket --admin-password=admin --db-root-password=admin --install-app erpnext --set-default; + bench new-site --no-mariadb-socket --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend; db: image: mariadb:10.6 diff --git a/docs/single-server-example.md b/docs/single-server-example.md index 1b617109..4176f61e 100644 --- a/docs/single-server-example.md +++ b/docs/single-server-example.md @@ -175,7 +175,7 @@ Create sites `one.example.com` and `two.example.com`: ```shell # one.example.com docker compose --project-name erpnext-one exec backend \ - bench new-site one.example.com --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit + bench new-site --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit one.example.com ``` You can stop here and have a single bench single site setup complete. Continue to add one more site to the current bench. @@ -183,7 +183,7 @@ You can stop here and have a single bench single site setup complete. Continue t ```shell # two.example.com docker compose --project-name erpnext-one exec backend \ - bench new-site two.example.com --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit + bench new-site --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit two.example.com ``` #### Create second bench @@ -234,10 +234,10 @@ Create sites `three.example.com` and `four.example.com`: ```shell # three.example.com docker compose --project-name erpnext-two exec backend \ - bench new-site three.example.com --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit + bench new-site --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit three.example.com # four.example.com docker compose --project-name erpnext-two exec backend \ - bench new-site four.example.com --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit + bench new-site --no-mariadb-socket --mariadb-root-password changeit --install-app erpnext --admin-password changeit four.example.com ``` #### Create custom domain to existing site diff --git a/docs/site-operations.md b/docs/site-operations.md index fc81add4..793dfef5 100644 --- a/docs/site-operations.md +++ b/docs/site-operations.md @@ -9,7 +9,7 @@ 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. ```sh -docker-compose exec backend bench new-site --no-mariadb-socket --mariadb-root-password --admin-password +docker-compose exec backend bench new-site --no-mariadb-socket --mariadb-root-password --admin-password ``` If you need to install some app, specify `--install-app`. To see all options, just run `bench new-site --help`. @@ -24,7 +24,7 @@ docker-compose exec backend bench set-config -g root_password Also command is slightly different: ```sh -docker-compose exec backend bench new-site --no-mariadb-socket --db-type postgres --admin-password +docker-compose exec backend bench new-site --no-mariadb-socket --db-type postgres --admin-password ``` ## Push backup to S3 storage diff --git a/pwd.yml b/pwd.yml index fb1cd05e..e43d2c10 100644 --- a/pwd.yml +++ b/pwd.yml @@ -67,7 +67,7 @@ services: fi done; echo "sites/common_site_config.json found"; - bench new-site frontend --no-mariadb-socket --admin-password=admin --db-root-password=admin --install-app erpnext --set-default; + bench new-site --no-mariadb-socket --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend; db: image: mariadb:10.6