You can invite me with this link. Thanks for using Luminara!

Self-host

The next part of this README explains how to self-host Lumi, this allows you to host your own version of my code and create a personalized Discord bot.

Note: because the .slots and .blackjack commands use custom (animated) emoji, these commands will break when you self-host Lumi. Please replace the ID values in config/JSON/resources.json with your own set of emotes.

Installation

Docker

Lumi comes containerized with essential components such as MariaDB, its core application, Adminer, and Dozzle. To ensure smooth operation of Dozzle, it's necessary to copy users.yml.example to users.yml and configure an authentication user as outlined in the file. Refer to the file for detailed instructions.

To install Lumi, run these commands:

git clone https://git.wlinator.org/Luminara/Core && cd Core

Copy .env.template to .env and fill out the variables.

docker compose up -d --build

Please note that it's highly recommended to establish a reverse proxy setup for Adminer and Dozzle, ensuring better security and accessibility.

Adminer should be directed to port 8080.
Dozzle should be mapped to port 8081.

Alternative

You can run Lumi without Docker, however I don't provide support or documentation for this. Here are some requirements to get you started.

MariaDB server on port 3306.
Python 3.11 with the required pip packages.
See the environment variables in docker-compose.yml and set them manually.

Environment variables (.env)

TOKEN: your Discord Bot Token, you can get this here.
DBX_*: set these up if you want to make database backups to your Dropbox app.
MARIADB_USER: the username for your MariaDB database.
MARIADB_PASSWORD: the password for your database.
MARIADB_ROOT_PASSWORD: can be ignored unless you have a specific use for it.
MARIADB_DATABASE: the name of your database.

Other variables can be specified in docker.compose.yml (core)

Some icons used in Lumi are provided by Icons8.

2.4 KiB Raw Blame History