From 1376016560fbfa40d94c384bcec10c3da3961bef Mon Sep 17 00:00:00 2001 From: Poag Date: Wed, 29 Jun 2016 15:14:32 +0100 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 28fc2c2..c25717e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,33 @@ # NadekoBot a Discord bot Nadeko is written in C# and Discord.net for more information visit https://github.com/Kwoth/NadekoBot +## Install Docker +Follow the respective guide for your operating system found here https://docs.docker.com/engine/installation/ -## Docker Usage +## Nadeko Setup Guide +For this guide we will be using the folder /nadeko as our config root folder. ``` -docker create --name nadeko -v /:/config uirel/nadeko +docker run --name nadeko -v /nadeko:/config uirel/nadeko ``` -Edit the path to the location you want to store your credentials.json files. eg /appdata or /nadeko +Lots of text will scroll past as the container is setup. After a few minutes it will start looping with an error about a lack of a token. +Press CTRL+C at this point. + +Edit your /nadeko/credentials.json file per the guide @ https://github.com/Kwoth/NadekoBot/wiki/Credentials.json-and-data-config.json using a tool of your choice eg nano +''' +nano /nadeko/credentials.json +''' +Atfer editing the config file we can restart Nadeko -Edit your credentials.json file per the guide @ https://github.com/Kwoth/NadekoBot then ``` docker start nadeko ``` + +After a few moments you should be able to invite Nadeko to your server. If you cannot check the log file for errors + +'''docker logs nadeko''' + + **Parameters** * -v /:/config - This is the file location of your persistent information. Your DB and credential information