Self-Hosting
If you are hosting your own instance, or wish to run a modified version of the bot, you can self-host it.
Important
Due to limited time and resources, I can not offer free self-hosting support. If you’d like paid assistance, or to have AutoMod hosted on your behalf in a paid capacity, please contact Vale.
Important
This is a technical guide intended for people who wish to setup their own Revolt instance.
It is not for the average end user. If you wish to add AutoMod to your server, you can invite it.
Prerequisites
Ensure you have the following:
Installation
Clone the AutoMod repository
git clone https://github.com/DeclanChidlow/AutoMod
Enter the AutoMod directory
cd AutoMod
Setup configurations
Copy the example configuration files to create the actual configuration files:cp compose.yml.example compose.yml
cp .env.example .env
You will need to edit
.env
to populate it with the relevant details. While the defaultcompose.yml
will work out of the box in most situations, you might need to tweak it depending on your specific configuration.Build AutoMod
docker compose build
Run it with Docker
Start AutoMod withdocker compose up
and consult the logs. Assuming it runs without issues and nothing seems amiss, you can stop it, and restart it to run in the background (detached mode) withdocker compose up -d
.
Updating
Ensure you are in the AutoMod directory
cd AutoMod
Stop AutoMod
docker compose stop
Pull the latest changes
This will copy the latest changes from GitHub to your local machine.git pull
Build AutoMod
docker compose build
Start AutoMod
Start AutoMod withdocker compose up
and consult the logs. Assuming it runs without issues and nothing seems amiss, you can stop it, and restart it to run in the background (detached mode) withdocker compose up -d
.