Browse Source

Add information about the configuration to the README

dev_h
Ophir LOJKINE 5 years ago
parent
commit
21229fe6fd
1 changed files with 8 additions and 0 deletions
  1. 8
    0
      README.md

+ 8
- 0
README.md View File

77
 WBO is available in multiple languages. The translations are stored in [`server/translations.json`](./server/translations.json). 
77
 WBO is available in multiple languages. The translations are stored in [`server/translations.json`](./server/translations.json). 
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).
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
 ## Troubleshooting
88
 ## Troubleshooting
81
 
89
 
82
 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).
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).

Loading…
Cancel
Save