From 6839a264dbc4346cd742e828ff470dbde0128336 Mon Sep 17 00:00:00 2001 From: derfenix Date: Tue, 28 Mar 2023 19:47:18 +0300 Subject: [PATCH] Add configuration to README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a080c59..86c6a41 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,18 @@ Aimed to be a simple, fast and easy-to-use webarchive for personal or home-net u * Golang 1.19 or higher * wkhtmltopdf binary in $PATH (to save pages in pdf) +## Configuration + +The service can be configured via environment variables. There is a list of available +variables: + +* **DB_PATH** — path for the database files (default `./db`) +* **LOGGING_DEBUG** — enable debug logs (default `false`) + + +*Note*: Prefix **WEBARCHIVE_** can be used with the environment variable names +in case of any conflicts. + ## Usage #### 1. Start the server