From fad495cbe1b62268acf4ace7d1890546bcca03af Mon Sep 17 00:00:00 2001 From: Trivernis Date: Sat, 9 Feb 2019 13:32:51 +0100 Subject: [PATCH] Updated Readme --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ee1646..28861b6 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,21 @@ The arguments are optional because the token and youtube-api-key that the bot ne "webservice": { // optional "enabled": true, // enable the server "port": 8080, // set the port - "graphiql": false // switch the graphiql interface on/off + "graphiql": false, // switch the graphiql interface on/off, + "sessionSecret": "PROVIDE A SECURE SECRET", + "https": { + "enabled": true, //enable https + "keyFile": "PATH TO YOUR SSL KEY FILE", + "certFile": "PATH TO YOUR SSL CERTIFICATE FILE" + } } } ``` If the keys are missing from the config file, the bot exits. This behaviour can be deactivated by setting the `-i` commandline flag. -You need to generate an api-token to access the graphql webservice. You can generate one with the owner-command `tokengen` uses via PM. +You need to create a user to access the webinterface. Use `~createUser [name] [password] [scope]` to create one (Only works via PM). +Please provide a **SECURE** `sessionSecred`. +To enable https you need a certificate and key file. Those can be generated with openssl. Keys --- @@ -61,4 +69,4 @@ Ideas - command replies saved in file (server specific file and global file) - reddit api - anilist api -- othercoolstuff api \ No newline at end of file +- othercoolstuff api