ready for v1.0rc1

README.md

@@ -25,3 +25,31 @@ GOOS=openbsd make vendor
 ## Install
 
 See the `scripts/` directory on how to install docstore on OpenBSD.
+
+## Config
+
+```
+{
+	"run_dir": "/var/lib/docstore",    // running directory. data will be stored here
+	"user": "docstore",                // drop privileges to user
+	"group": "docstore",               // drop privileges to group
+	"listen_addr": "127.0.0.1:8080",   // listening <address>:<port>
+	"log_file": "docstore.log",        // log file (use - for stdout, this only works in combination with 'foreground: true')
+	"secret": "",                      // static hmac secret (at least 64 chars, used for JWT signing)
+	"langs": ["deu", "eng"],           // languages for tesseract ocr
+	"cmd_timeout": 600,                // timeout in seconds for executed teseract and pdftotext commands
+	"tesseract_threads": 1,            // tesseract thread limit
+	"tesseract_oem": 1,                // tesseract oem value
+	"foreground": false,               // do not fork into the background
+	"secure_cookie": false,            // enable secure cookie flag
+	"debug": false                     // enable debugging
+}
+```
+
+## Usage
+
+DocStore manages all files and directories under the `$run_dir/data` directory.
+
+Do not delete or move files around in the `$run_dir/data` directory using the filesystem as this messes with the index mapping.
+
+You can however add more files and directories using the underlying file system.