From 9c6cd2c2310d2e3ce3d1a6e3350a97e7ba0ca657 Mon Sep 17 00:00:00 2001
From: RblSb <msrblsb@gmail.com>
Date: Mon, 24 Feb 2020 07:58:56 +0300
Subject: Start working on user folder

---
 user/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 user/README.md

(limited to 'user')

diff --git a/user/README.md b/user/README.md
new file mode 100644
index 0000000..f59e576
--- /dev/null
+++ b/user/README.md
@@ -0,0 +1,18 @@
+## User-specific config
+You can create `config.json` file in this folder to override `default-config.json` options.
+All root config fields are optional to override, so you need to create only what you want to change.
+File example:
+```json
+{
+	"channelName": "-=SuperChannel=-",
+	"videoLimit": 10,
+}
+```
+## User-specific resources
+You can patch any file you want in project `res/` by creating `user/res/sameName` files.
+For example `user/res/index.html` or `user/res/css/custom.css`.
+You can also add any new files.
+## Other files here
+- `state.json` - saved state of latest server session (messages, videos, video time).
+- `logs/` - latest 10 logs. You can change count in config.
+- `crashes/` - folder with latest error logs, when the server had to restart itself.
-- 
cgit v1.2.3