nadeko/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

2016-05-06 08:19:30 +00:00
# NadekoBot a Discord bot
Nadeko is written in C# and Discord.net for more information visit https://github.com/Kwoth/NadekoBot
2016-06-29 14:14:32 +00:00
## Install Docker
Follow the respective guide for your operating system found here https://docs.docker.com/engine/installation/
2016-05-06 08:19:30 +00:00
2016-06-29 14:14:32 +00:00
## Nadeko Setup Guide
For this guide we will be using the folder /nadeko as our config root folder.
2016-05-06 08:19:30 +00:00
```
2016-06-29 14:14:32 +00:00
docker run --name nadeko -v /nadeko:/config uirel/nadeko
2016-05-06 08:19:30 +00:00
```
2016-06-29 14:14:32 +00:00
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
2016-05-06 08:19:30 +00:00
2016-05-09 07:50:26 +00:00
```
docker start nadeko
```
2016-06-29 14:14:32 +00:00
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'''
2016-05-06 08:19:30 +00:00
**Parameters**
2016-05-09 07:50:26 +00:00
* -v /<appdata>:/config - This is the file location of your persistent information. Your DB and credential information
2016-05-06 08:19:30 +00:00
## Updates / Monitoring
2016-05-06 08:35:56 +00:00
* Upgrade to the latest version of Nadeko simply `docker restart nadeko`.
2016-05-06 08:19:30 +00:00
* Monitor the logs of the container in realtime `docker logs -f nadeko`.
2016-05-06 08:20:57 +00:00
For information about configuring your bot or its functionality, please check the https://github.com/Kwoth/NadekoBot guides.