Explain config options

This commit is contained in:
1computer1 2019-05-14 20:50:07 -04:00
parent a3893052cd
commit b0f9fef546
2 changed files with 17 additions and 8 deletions

View file

@ -92,8 +92,20 @@ The container is locked down, so there is no networking, limited memory and CPU
## Setup ## Setup
0. Install Docker 0. Install Docker 18+
0. Install Node 0. Install Node 10+
0. Run `npm i` 0. Run `npm i`
0. Fill out `config.json` 0. Fill out `config.json`
- `owner` - The owner(s) of the bot.
Use an array for multiple owners.
- `token` - The bot token.
- `languages` Languages to use.
The language names here are different from the user-facing ones.
Check the folders in ./docker/ for the language names.
Change to null to enable all languages.
- `memory` Max memory usage of a container.
- `cpu` Max CPU usage of a container.
- `timeout` Time limit for code in milliseconds.
- `prepare` Whether to run containers on setup.
Setting to true will speed up the first eval, but that language might not be used.
0. Run `node .` 0. Run `node .`

View file

@ -1,13 +1,10 @@
{ {
"owner": "Discord ID of the bot owner(s)", "owner": "12345678901234",
"token": "Bot token", "token": "MTU1fdsYNTRb2RT.FcD2l1ig.jIuKqwertyd432RROhF5A",
"languages": [ "languages": [
"Language whitelist, e.g.",
"haskell", "haskell",
"python", "python",
"The language names here are different from the user-facing ones.", "javascript"
"Check the folders in docker/ for the language names.",
"Change to null to enable all languages."
], ],
"memory": "128m", "memory": "128m",
"cpus": "0.5", "cpus": "0.5",