Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 2.19 KB

README.md

File metadata and controls

40 lines (29 loc) · 2.19 KB
Raw

Starboard-4

A feature-rich and reliable Starboard bot, trusted by thousands of servers.

Features

  • Multiple starboards per server
  • Multiple emojis per starboard
  • 25+ configurable options for starboards
  • Per-channel setting overrides
  • Per-role permissions
  • Autostar channels

Quickstart

  • Use /starboards create name: starboard-name channel: #starboard to create a starboard.
  • Use /starboards view name: starboard-name to view the settings.
  • Use /starboards edit [behavior|requirements|style|embed] name: starboard-name [options...] to edit a starboard.

Self-hosting

You're welcome to self-host this bot if you like, as well as fork it and add your own changes. If there are features you wish the main bot had, you're also welcome to open PRs or make an issue requesting features.

Currently, I offer support for self-hosting the bot if you get stuck - just join the support server, and create a thread with the "Self Hosting" tag.

This guide assumes that you already have a VPS to host the bot on. Some good low-cost providers are https://www.netcup.eu (what the main bot uses) and https://alphavps.com.

I'll add a proper self-hosting guide later, but essentially you need a PostgreSQL database, a .env file filled with the required variables from .env.example, and the pre-build docker image. To get the latest docker image from docker hub, use docker pull circuitsacul/starboard:latest. Start the bot with docker run -d --env-file .env --network=host circuitsacul/starboard:latest.

Migration from Starboard-3

If you're already hosting starboard-3 and want to switch to starboard-4, you have to alter the database structure.

Start by running psql postgresql. Then you can run:

CREATE DATABASE starboard_4 WITH OWNER <starboard username> TEMPLATE <old database name>;

Now exit, and then run psql starboard_4 < migrate.sql where migrate.sql is the file found in this repo.

After doing this, you should be able to launch starboard-4.