From 3a39df65790cf6108f26e36e93e0b3eab2083afa Mon Sep 17 00:00:00 2001 From: Lou Knauer Date: Wed, 6 Jul 2022 15:06:04 +0200 Subject: [PATCH] Update documentation (Fixes #2) --- configs/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/configs/README.md b/configs/README.md index 633ec54..143406a 100644 --- a/configs/README.md +++ b/configs/README.md @@ -10,7 +10,8 @@ All security relevant configuration. e.g., keys and passwords, are set using env * `user`: Type string. Drop root permissions once .env was read and the port was taken. Only applicable if using privileged port. * `group`: Type string. Drop root permissions once .env was read and the port was taken. Only applicable if using privileged port. * `disable-authentication`: Type bool. Disable authentication (for everything: API, Web-UI, ...). Default `false`. -* `static-files`: Type string. Folder where static assets can be found, those will be served directly. Default `./frontend/public`. +* `embed-static-files`: Type bool. If all files in `web/frontend/public` should be served from within the binary itself (they are embedded) or not. Default `true`. +* `static-files`: Type string. Folder where static assets can be found, if `embed-static-files` is `false`. No default. * `db-driver`: Type string. 'sqlite3' or 'mysql' (mysql will work for mariadb as well). Default `sqlite3`. * `db`: Type string. For sqlite3 a filename, for mysql a DSN in this format: https://github.com/go-sql-driver/mysql#dsn-data-source-name (Without query parameters!). Default: `./var/job.db`. * `job-archive`: Type string. Path to the job-archive. Default: `./var/job-archive`.