From 54d423a11f5710b491000988990dd884bcad34e5 Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Thu, 6 Aug 2020 14:27:29 +1000 Subject: [PATCH] Updated doc for sqlite --- .jenkins/config-sqlite.json | 10 ---------- docs/setup/README.md | 20 ++++++++++++++++++-- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/.jenkins/config-sqlite.json b/.jenkins/config-sqlite.json index c4ead63d..97d688d2 100644 --- a/.jenkins/config-sqlite.json +++ b/.jenkins/config-sqlite.json @@ -5,16 +5,6 @@ "client": "sqlite3", "connection": { "filename": "/data/database.sqlite" - }, - "pool": { - "min": 0, - "max": 1, - "createTimeoutMillis": 3000, - "acquireTimeoutMillis": 30000, - "idleTimeoutMillis": 30000, - "reapIntervalMillis": 1000, - "createRetryIntervalMillis": 100, - "propagateCreateError": false } } } diff --git a/docs/setup/README.md b/docs/setup/README.md index 3acdc7bf..52160e17 100644 --- a/docs/setup/README.md +++ b/docs/setup/README.md @@ -23,15 +23,31 @@ Here's an example configuration for `mysql` (or mariadb) that is compatible with } ``` +Alternatively if you would like to use a Sqlite database file: + +```json +{ + "database": { + "engine": "knex-native", + "knex": { + "client": "sqlite3", + "connection": { + "filename": "/data/database.sqlite" + } + } + } +} +``` + Once you've created your configuration file it's easy to mount it in the docker container. **Note:** After the first run of the application, the config file will be altered to include generated encryption keys unique to your installation. These keys affect the login and session management of the application. If these keys change for any reason, all users will be logged out. -### Database +### MySQL Database -This app doesn't come with a database, you have to provide one yourself. Currently only `mysql/mariadb` is supported for the minimum versions: +If you opt for the MySQL configuration you will have to provide the database server yourself. You can also use MariaDB. Here are the minimum supported versions: - MySQL v5.7.8+ - MariaDB v10.2.7+