~qeef/damn-deploy

eb0194698118e1f7879e554f630247a5ac0a1d29 — Jiri Vlasak 3 months ago 1ad4660
Add server setup introduction
1 files changed, 7 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +7 -0
@@ 43,6 43,13 @@ section for the database periodic upkeep scripts.
Server setup
------------

There are few services within the `server.yml` docker compose file. There is
`db` and `api` services. These are the core services. `db` serves the database
and the `api` is the JSON REST (Fast)API to the database. Then, there is the
`upkeep` that runs periodic tasks on the database. (See the *Damn upkeep*
section.) The next is the `www` service serving the web pages. Finally, the
`traefik` service provides the gate to all the services above.

1. Set environment variables in `.env` file. The following is the meaning:

    - `POSTGRES_PASSWORD`: Password to PostgreSQL database.