NadekoBot/docs/guides/Docker Guide.md

59 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2016-12-12 15:28:57 +00:00
# NadekoBot a Discord bot
2017-01-11 13:07:39 +00:00
Nadeko is written in C# and Discord.net for more information visit <https://github.com/Kwoth/NadekoBot>
2016-08-01 15:55:38 +00:00
2016-12-12 15:28:57 +00:00
## Install Docker
2017-01-11 13:07:39 +00:00
Follow the respective guide for your operating system found here [Docker Engine Install Guide](https://docs.docker.com/engine/installation/)
2016-12-12 15:28:57 +00:00
## Nadeko Setup Guide
For this guide we will be using the folder /nadeko as our config root folder.
2017-01-11 13:07:39 +00:00
```bash
docker create --name=nadeko -v /nadeko/data:/opt/NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.0/data -v /nadeko/credentials.json:/opt/NadekoBot/src/NadekoBot/credentials.json uirel/nadeko
2016-12-12 15:28:57 +00:00
```
-If you are coming from a previous version of nadeko (the old docker) make sure your crednetials.json has been copied into this directory and is the only thing in this folder.
2017-01-11 13:07:39 +00:00
-If you are making a fresh install, create your credentials.json from the following guide and palce it in the /nadeko folder [Nadeko JSON Guide](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/)
2016-12-12 15:28:57 +00:00
Next start the docker up with
2017-01-11 13:07:39 +00:00
`docker start nadeko; docker logs -f nadeko`
2016-12-12 15:28:57 +00:00
The docker will start and the log file will start scrolling past. Depending on hardware the bot start can take up to 5 minutes on a small DigitalOcean droplet.
Once the log ends with "NadekoBot | Starting NadekoBot v1.0-rc2" the bot is ready and can be invited to your server. Ctrl+C at this point to stop viewing the logs.
After a few moments you should be able to invite Nadeko to your server. If you cannot check the log file for errors
## Monitoring
2016-12-12 15:28:57 +00:00
* Monitor the logs of the container in realtime `docker logs -f nadeko`.
## Updates
2017-01-11 12:50:39 +00:00
# Manual
Updates are handled by pulling the new layer of the Docker Container which contains a pre compiled update to Nadeko.
The following commands are required for the default options
2017-01-11 13:07:39 +00:00
`docker pull uirel/nadeko:latest`
`docker stop nadeko; docker rm nadeko`
`docker create --name=nadeko -v /nadeko/data:/opt/NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.0/data -v /nadeko/credentials.json:/opt/NadekoBot/src/NadekoBot/credentials.json uirel/nadeko`
`docker start nadeko`
2017-01-11 12:50:39 +00:00
# Automatic Updates
2017-01-11 13:07:39 +00:00
Automatic update are now handled by watchertower [WatchTower GitHub](https://github.com/CenturyLinkLabs/watchtower)
To setup watchtower to keep Nadeko up-to-date for you with the default settings use the following command
2017-01-11 13:07:39 +00:00
```bash
docker run -d --name watchtower -v /var/run/docker.sock:/var/run/docker.sock centurylink/watchtower --cleanup nadeko
```
This will check for updates to the docker every 5 minutes and update immediately. Alternatively using the `--interval X` command to change the interval, where X is the amount of time in seconds to wait. eg 21600 for 6 hours.
2016-12-12 15:28:57 +00:00
If you have any issues with the docker setup, please ask in #help but indicate you are using the docker.
2017-01-11 13:07:39 +00:00
For information about configuring your bot or its functionality, please check the <http://nadekobot.readthedocs.io/en/latest> guides.