From 940836b25b3ff082c8de8ef50837bb27c8bdbd55 Mon Sep 17 00:00:00 2001 From: Nicola Murino Date: Mon, 30 Nov 2020 21:59:56 +0100 Subject: [PATCH] add a note about using sqlite provider over cifs shares See #235 --- docs/full-configuration.md | 2 +- kms/kms.go | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/full-configuration.md b/docs/full-configuration.md index c623a7c0..29b83d91 100644 --- a/docs/full-configuration.md +++ b/docs/full-configuration.md @@ -115,7 +115,7 @@ The configuration file contains the following sections: - `max_size`, integer. Maximum number of users to cache. 0 means unlimited. Default: 50. - **"data_provider"**, the configuration for the data provider - `driver`, string. Supported drivers are `sqlite`, `mysql`, `postgresql`, `bolt`, `memory` - - `name`, string. Database name. For driver `sqlite` this can be the database name relative to the config dir or the absolute path to the SQLite database. For driver `memory` this is the (optional) path relative to the config dir or the absolute path to the provider dump, obtained using the `dumpdata` REST API, to load. This dump will be loaded at startup and can be reloaded on demand sending a `SIGHUP` signal on Unix based systems and a `paramchange` request to the running service on Windows. The `memory` provider will not modify the provided file so quota usage and last login will not be persisted + - `name`, string. Database name. For driver `sqlite` this can be the database name relative to the config dir or the absolute path to the SQLite database. For driver `memory` this is the (optional) path relative to the config dir or the absolute path to the provider dump, obtained using the `dumpdata` REST API, to load. This dump will be loaded at startup and can be reloaded on demand sending a `SIGHUP` signal on Unix based systems and a `paramchange` request to the running service on Windows. The `memory` provider will not modify the provided file so quota usage and last login will not be persisted. If you plan to use a SQLite database over a `cifs` network share (this is not recommended in general) you must use the `nobrl` mount option otherwise you will get the `database is locked` error. Some users reported that the `bolt` provider works fine over `cifs` shares. - `host`, string. Database host. Leave empty for drivers `sqlite`, `bolt` and `memory` - `port`, integer. Database port. Leave empty for drivers `sqlite`, `bolt` and `memory` - `username`, string. Database user. Leave empty for drivers `sqlite`, `bolt` and `memory` diff --git a/kms/kms.go b/kms/kms.go index b80368bb..e845c53b 100644 --- a/kms/kms.go +++ b/kms/kms.go @@ -1,3 +1,4 @@ +// Package kms provides Key Management Services support package kms import (