tobast/matrix-alertbot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'anoa/docker_docs' into master

Browse source 
* anoa/docker_docs:
  Improve docker documentation
This commit is contained in:
Andrew Morgan 2020-08-16 17:01:49 +01:00
commit 98e1262b16
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docker/README.md
View file

@ -26,12 +26,16 @@ created `data` directory. Fill it out as you normally would, with a few minor
differences: differences:
* The bot store directory should reside inside of the data directory so that it * The bot store directory should reside inside of the data directory so that it
is not wiped on container restart. Change it from the default to `/data/store`. is not wiped on container restart. Change it from the default to
There is no need to create this directory yourself, my-project-name will `/data/store`. There is no need to create this directory yourself, it will be
create it on startup if it does not exist. created on startup if it does not exist.
* Choose whether you want to use SQLite or Postgres as your database backend. If * Choose whether you want to use SQLite or Postgres as your database backend.
using SQLite, ensure your database file is stored inside the `/data` directory: Postgres has increased performance over SQLite, and is recommended for
deployments with many users.
If using SQLite, ensure your database file is
stored inside the `/data` directory:
``` ```
database: "sqlite:///data/bot.db" database: "sqlite:///data/bot.db"
@ -66,8 +70,8 @@ docker volume create \
--opt device="/path/to/data/dir" data_volume --opt device="/path/to/data/dir" data_volume
``` ```
If you want to use the postgres container defined in `docker-compose.yaml`, start that Optional: If you want to use the postgres container defined in
first: `docker-compose.yaml`, start that first:
``` ```
docker-compose up -d postgres docker-compose up -d postgres