From e06c30a0ee80c6fb746041852bc4a92e598174f6 Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Sat, 13 Jun 2020 15:47:31 +0530 Subject: [PATCH] docs: explain SITE_NAME [skip travis] --- docs/single-bench.md | 8 ++++---- docs/site-operations.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/single-bench.md b/docs/single-bench.md index ef3b20ab..25041649 100644 --- a/docs/single-bench.md +++ b/docs/single-bench.md @@ -34,12 +34,12 @@ To get started, copy the existing `env-local` or `env-production` file to `.env` - `MARIADB_HOST=mariadb` - Sets the hostname to `mariadb`. This is required if the database is managed by the containerized MariaDB instance. - In case of a separately managed database setups, set the value to the database's hostname/IP/domain. -- `SITE_NAME=mysite.localhost` - - Creates this site after starting all services and installs ERPNext. -- ``SITES=`${SITE_NAME}` `` +- `SITE_NAME=erp.example.com` + - Creates this site after starting all services and installs ERPNext. Site name is domain name that resolves. e.g. `erp.example.com` or `mysite.localhost` +- ``SITES=`erp.example.com` `` - List of sites that are part of the deployment "bench" Each site is separated by a comma(,) and quoted in backtick (`). By default site created by ``SITE_NAME`` variable is added here. - If LetsEncrypt is being setup, make sure that the DNS for all the site's domains correctly point to the current instance. -- `LETSENCRYPT_EMAIL=your.email@your.domain.com` +- `LETSENCRYPT_EMAIL=email@example.com` - Email for LetsEncrypt expiry notification. This is only required if you are setting up LetsEncrypt. Notes: diff --git a/docs/site-operations.md b/docs/site-operations.md index 2bd0212b..5fa29483 100644 --- a/docs/site-operations.md +++ b/docs/site-operations.md @@ -31,7 +31,7 @@ docker run \ Environment Variables needed: -- `SITE_NAME`: name of the new site to create. +- `SITE_NAME`: name of the new site to create. Site name is domain name that resolves. e.g. `erp.example.com` or `erp.localhost`. - `DB_ROOT_USER`: MariaDB Root user. - `MYSQL_ROOT_PASSWORD`: In case of the MariaDB docker container use the one set in `MYSQL_ROOT_PASSWORD` in previous steps. In case of a managed database use the appropriate password. - `MYSQL_ROOT_PASSWORD_FILE` - When the MariaDB root password is stored using docker secrets.