Skip to content

Commit

Permalink
revert: quote percent as mentioned in bench help
Browse files Browse the repository at this point in the history
  • Loading branch information
revant committed Dec 10, 2024
1 parent 1505d12 commit 85e164f
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 20 deletions.
2 changes: 1 addition & 1 deletion development/installer.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def create_site_in_bench(args):
"new-site",
f"--db-host=mariadb", # Should match the compose service name
f"--db-type={args.db_type}", # Add the selected database type
f"--mariadb-user-host-login-scope='%'",
f"--mariadb-user-host-login-scope=%",
f"--db-root-password=123", # Replace with your MariaDB password
f"--admin-password={args.admin_password}",
]
Expand Down
8 changes: 4 additions & 4 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,26 +144,26 @@ sed -i '/redis/d' ./Procfile
You can create a new site with the following command:

```shell
bench new-site --mariadb-user-host-login-scope='%' sitename
bench new-site --mariadb-user-host-login-scope=% sitename
```

sitename MUST end with .localhost for trying deployments locally.

for example:

```shell
bench new-site --mariadb-user-host-login-scope='%' development.localhost
bench new-site --mariadb-user-host-login-scope=% development.localhost
```

The same command can be run non-interactively as well:

```shell
bench new-site --db-root-password 123 --admin-password admin --mariadb-user-host-login-scope='%' development.localhost
bench new-site --db-root-password 123 --admin-password admin --mariadb-user-host-login-scope=% development.localhost
```

The command will ask the MariaDB root password. The default root password is `123`.
This will create a new site and a `development.localhost` directory under `frappe-bench/sites`.
The option `--mariadb-user-host-login-scope='%'` will configure site's database credentials to work with docker.
The option `--mariadb-user-host-login-scope=%` will configure site's database credentials to work with docker.
You may need to configure your system /etc/hosts if you're on Linux, Mac, or its Windows equivalent.

To setup site with PostgreSQL as database use option `--db-type postgres` and `--db-host postgresql`. (Available only v12 onwards, currently NOT available for ERPNext).
Expand Down
4 changes: 2 additions & 2 deletions docs/migrate-from-multi-image-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ configurator:

### Site Creation

For `create-site` service to act as run once site creation job, you need to pass `["bash", "-c"]` as container `entrypoint` and bash script inline to yaml. Make sure to use `--mariadb-user-host-login-scope='%'` as upstream bench is installed in container.
For `create-site` service to act as run once site creation job, you need to pass `["bash", "-c"]` as container `entrypoint` and bash script inline to yaml. Make sure to use `--mariadb-user-host-login-scope=%` as upstream bench is installed in container.

The `WORKDIR` has changed to `/home/frappe/frappe-bench` like `bench` setup we are used to. So the path to find `common_site_config.json` has changed to `sites/common_site_config.json`.

Expand Down Expand Up @@ -106,7 +106,7 @@ create-site:
fi
done;
echo "sites/common_site_config.json found";
bench new-site --mariadb-user-host-login-scope='%' --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend;
bench new-site --mariadb-user-host-login-scope=% --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend;
# ... removed for brevity
```
2 changes: 1 addition & 1 deletion docs/setup_for_linux_mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ services:
fi
done;
echo "sites/common_site_config.json found";
bench new-site --mariadb-user-host-login-scope='%' --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend;
bench new-site --mariadb-user-host-login-scope=% --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend;
db:
image: mariadb:10.6
Expand Down
8 changes: 4 additions & 4 deletions docs/single-server-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,15 +177,15 @@ Create sites `one.example.com` and `two.example.com`:
```shell
# one.example.com
docker compose --project-name erpnext-one exec backend \
bench new-site --mariadb-user-host-login-scope='%' --db-root-password changeit --install-app erpnext --admin-password changeit one.example.com
bench new-site --mariadb-user-host-login-scope=% --db-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.

```shell
# two.example.com
docker compose --project-name erpnext-one exec backend \
bench new-site --mariadb-user-host-login-scope='%' --db-root-password changeit --install-app erpnext --admin-password changeit two.example.com
bench new-site --mariadb-user-host-login-scope=% --db-root-password changeit --install-app erpnext --admin-password changeit two.example.com
```

#### Create second bench
Expand Down Expand Up @@ -236,10 +236,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 --mariadb-user-host-login-scope='%' --db-root-password changeit --install-app erpnext --admin-password changeit three.example.com
bench new-site --mariadb-user-host-login-scope=% --db-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 --mariadb-user-host-login-scope='%' --db-root-password changeit --install-app erpnext --admin-password changeit four.example.com
bench new-site --mariadb-user-host-login-scope=% --db-root-password changeit --install-app erpnext --admin-password changeit four.example.com
```

#### Create custom domain to existing site
Expand Down
4 changes: 2 additions & 2 deletions docs/site-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 --mariadb-user-host-login-scope='%' --db-root-password <db-password> --admin-password <admin-password> <site-name>
docker-compose 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`.
Expand All @@ -24,7 +24,7 @@ docker-compose exec backend bench set-config -g root_password <root-password>
Also command is slightly different:

```sh
docker-compose exec backend bench new-site --mariadb-user-host-login-scope='%' --db-type postgres --admin-password <admin-password> <site-name>
docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --db-type postgres --admin-password <admin-password> <site-name>
```

## Push backup to S3 storage
Expand Down
10 changes: 4 additions & 6 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,9 @@ def frappe_site(compose: Compose):
site_name = "tests.localhost"
compose.bench(
"new-site",
"--mariadb-user-host-login-scope='%'",
"--db-root-password",
"123",
"--admin-password",
"admin",
"--mariadb-user-host-login-scope=%",
"--db-root-password=123",
"--admin-password=admin",
site_name,
)
compose("restart", "backend")
Expand All @@ -96,7 +94,7 @@ def erpnext_site(compose: Compose):
site_name = "test-erpnext-site.localhost"
args = [
"new-site",
"--mariadb-user-host-login-scope='%'",
"--mariadb-user-host-login-scope=%",
"--db-root-password",
"123",
"--admin-password",
Expand Down

0 comments on commit 85e164f

Please sign in to comment.