Autoclear

Quick start

So you have your beautiful server and this wonderful bot you just found, what now? Set up channels of course.

Commands

** Owner only

FAQ

Self hosting guide

Here be dragons, make sure you know what you are doing! Autoclear is now dockerized, which should make self-hosting much easier.

Install required tools

  1. Clone the repo
  2. Install Docker

Special Instructions for Linux

  1. Head to the releases section of the Docker Compose repository.
  2. Download the correct binary for your system - this will probably be x86_64 but you can always check with uname -m.
  3. Move the binary to one of the directories listed here - MAKE SURE THE DIRECTORY EXISTS BEFORE MOVING THE FILE!
  4. Allow execution of the binary sudo chmod +x name_of_binary.
  5. Reload shell if docker compose does not work.

ENV variables

Only the bot token is required when running in Docker.

Now create a file named .env and add all of the values

Get ready

  1. In the project root, start the bot with docker compose up -d (take note of the missing hypen).
  2. That’s it.

Development Setup

  1. Install Node.js (16.6.0+ required)
  2. Install PostgreSQL 14
  3. Create database and load the template in.
  4. Install the required dependencies with npm install
  5. Create .env and fill in the file using the variable table above.
  6. Compile the project with npx tsc
  7. Start the bot with node dist

I need help

There is no dedicated server for autoclear, but I am usually available

Privacy Policy

Please see the privacy policy page

Terms of Service

Please see the terms of service page