diff --git a/docs/guides/Docker Guide.md b/docs/guides/Docker Guide.md index 6ed3a33e..474337d6 100644 --- a/docs/guides/Docker Guide.md +++ b/docs/guides/Docker Guide.md @@ -1,23 +1,22 @@ # NadekoBot a Discord bot -Nadeko is written in C# and Discord.net for more information visit https://github.com/Kwoth/NadekoBot +Nadeko is written in C# and Discord.net for more information visit ## Install Docker -Follow the respective guide for your operating system found here https://docs.docker.com/engine/installation/ +Follow the respective guide for your operating system found here [Docker Engine Install Guide](https://docs.docker.com/engine/installation/) ## Nadeko Setup Guide For this guide we will be using the folder /nadeko as our config root folder. -``` +```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 ``` -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. --If you are making a fresh install, create your credentials.json from the following guide and palce it in the /nadeko folder -http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/ +-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/) Next start the docker up with -```docker start nadeko; docker logs -f nadeko``` +`docker start nadeko; docker logs -f nadeko` 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. @@ -33,18 +32,27 @@ After a few moments you should be able to invite Nadeko to your server. If you c # 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 -1. ```docker pull uirel/nadeko:latest``` -2. ```docker stop nadeko; docker rm nadeko``` -3. ```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``` -4. ```docker start nadeko``` + +`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` + # Automatic Updates -Automatic update are now handled by watchertower https://github.com/CenturyLinkLabs/watchtower +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 -```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. + +```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. If you have any issues with the docker setup, please ask in #help but indicate you are using the docker. -For information about configuring your bot or its functionality, please check the http://nadekobot.readthedocs.io/en/latest guides. +For information about configuring your bot or its functionality, please check the guides.