Skip to content

Self Hosting

Declan Chidlow edited this page Sep 9, 2024 · 5 revisions

Prerequisites

Ensure you have the following installed on your system:

Installation

  1. Clone the AutoMod repository
    git clone https://github.com/DeclanChidlow/AutoMod

  2. Enter the AutoMod directory
    cd AutoMod

  3. 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 default compose.yml will work out of the box in most situations, you might need to tweak it depending on your specific configuration.

  4. Build AutoMod
    docker compose build

  5. Run it with Docker
    Start AutoMod with docker compose up. Assuming it runs without issues, you can stop it, and restart it to run in the background (detached mode) with docker compose up -d.

Updating

  1. Ensure you are in the AutoMod directory
    cd AutoMod

  2. Stop AutoMod
    docker compose stop

  3. Pull the latest changes
    This will copy the latest changes from GitHub to your local machine. git pull

  4. Build AutoMod
    docker compose build

  5. Start AutoMod
    Start AutoMod with docker compose up. Assuming it runs without issues, you can stop it, and start it in the background (detached mode) with docker compose up -d.

Clone this wiki locally