engineering
/
ramirez
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add docs on how to update the bot

cshd
Dragory 2020-10-27 19:26:11 +02:00
parent b0eb402b86
commit 8a27e25192
No known key found for this signature in database
GPG Key ID: 5F387BA66DF8AAC1
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -12,6 +12,7 @@ Always take a backup of your `db/data.sqlite` file before updating the bot.
## Getting started ## Getting started
* **[🛠️ Setting up the bot](docs/setup.md)** * **[🛠️ Setting up the bot](docs/setup.md)**
* **[✨ Updating the bot](docs/updating.md)**
* **[🙋 Frequently Asked Questions](docs/faq.md)** * **[🙋 Frequently Asked Questions](docs/faq.md)**
* [📝 Configuration](docs/configuration.md) * [📝 Configuration](docs/configuration.md)
* [🤖 Commands](docs/commands.md) * [🤖 Commands](docs/commands.md)

17
docs/updating.md Normal file
View File

@ -0,0 +1,17 @@
# ✨ Updating the bot
**Before updating the bot, always take a backup of your `db/data.sqlite` file.**
To update the bot, follow these steps:
1. Shut down the bot
2. Take a backup of your `db/data.sqlite` file
* If you're using a different supported database, take database backups from there
3. Download the latest version of the bot from https://github.com/Dragory/modmailbot/releases/latest
4. Extract the new version's files over the old files
5. Read the [CHANGELOG](https://github.com/Dragory/modmailbot/blob/master/CHANGELOG.md) to see if there are any config changes you have to make
* Especially note changes to supported Node.js versions!
6. Start the bot:
* If you're using `start.bat` to run the bot, just run it again
* If you're running the bot via command line, first run `npm ci` and then start the bot again
👉 If you run into any issues, **[join the support server for help!](https://discord.gg/vRuhG9R)**