docs: improve setup options

This commit is contained in:
Revant Nandgaonkar 2022-05-02 05:27:23 +05:30
parent 1929fa3d34
commit 5d2ab2ed58

View file

@ -21,6 +21,11 @@ Note: To know more about environment variable [read here](./images-and-compose-f
## Generate docker-compose.yml for variety of setups
Notes:
- Make sure to replace `<project-name>` with the desired name you wish to set for the project.
- This setup is not to be used for development. A complete development environment is available [here](../development)
### Store the yaml files
YAML files generated by `docker compose config` command can be stored in a directory. We will create a directory called `gitops` in the user's home.
@ -31,7 +36,7 @@ mkdir ~/gitops
You can make the directory into a private git repo which stores the yaml and secrets. It can help in tracking changes.
instead of `docker compose config`, you can directly use `docker compose up` and start the containers instead of storing the yamls in `gitops` directory.
Instead of `docker compose config`, you can directly use `docker compose up` to start the containers and skip storing the yamls in `gitops` directory.
### Setup Frappe without proxy and external MariaDB and Redis
@ -91,11 +96,6 @@ docker compose -f compose.yaml \
docker compose --project-name <project-name> -f ~/gitops/docker-compose.yml up -d
```
Notes:
- Make sure to replace `<project-name>` with the desired name you wish to set for the project.
- This setup is not to be used for development. A complete development environment is available [here](../development)
## Create first site
After starting containers, the first site needs to be created. Refer [site operations](./site-operations.md#setup-new-site).
@ -116,6 +116,12 @@ docker compose -f compose.yaml \
docker compose --project-name <project-name> -f ~/gitops/docker-compose.yml pull
# Stop containers
docker compose --project-name <project-name> -f ~/gitops/docker-compose.yml down
# Remove assets volume for repopulation
docker volume rm <name of assets volume>
# Restart containers
docker compose --project-name <project-name> -f ~/gitops/docker-compose.yml up -d
```