浏览代码

Add information about the configuration to the README

dev_h
Ophir LOJKINE 4 年前
父节点
当前提交
21229fe6fd
共有 1 个文件被更改,包括 8 次插入0 次删除
  1. 8
    0
      README.md

+ 8
- 0
README.md 查看文件

@@ -77,6 +77,14 @@ See instructions on our Wiki about [how to setup a reverse proxy for WBO](https:
77 77
 WBO is available in multiple languages. The translations are stored in [`server/translations.json`](./server/translations.json). 
78 78
 If you feel like contributing to this collaborative project, you can [translate WBO into your own language](https://github.com/lovasoa/whitebophir/wiki/How-to-translate-WBO-into-your-own-language).
79 79
 
80
+## Configuration
81
+
82
+When you start a WBO server, it loads its configuration from several environment variables.
83
+You can see a list of these variables in [`configuration.js`](./server/configuration.js).
84
+Some important environment variables are :
85
+ - `WBO_HISTORY_DIR` : configures the directory where the boards are saved. Defaults to `./server-data/`.
86
+ - `WBO_MAX_EMIT_COUNT` : the maximum number of messages that a client can send per unit of time. Increase this value if you want smoother drawings, at the expense of being susceptible to denial of service attacks if your server does not have enough processing power. 
87
+
80 88
 ## Troubleshooting
81 89
 
82 90
 If you experience an issue or want to propose a new feature in WBO, please [open a github issue](https://github.com/lovasoa/whitebophir/issues/new).

正在加载...
取消
保存