Luminara/Lumi
Luminara/Lumi
1
Fork 0
mirror of https://github.com/wlinator/luminara.git synced 2024-10-02 22:23:13 +00:00
Code Activity
Mirror of the Github repository https://github.com/wlinator/luminara
375 commits 5 branches 94 tags 4.8 MiB
Python 99.8%
Dockerfile 0.2%
Find a file
wlinator 35889186fc Merge branch 'dev' into 'main' 
Add webpage template to repository

See merge request wlinator/Racu!50
2024-04-06 12:11:36 +00:00
art Renew some icons 2024-03-28 20:03:50 +00:00
config Code clean-up 2024-03-29 13:17:51 -04:00
db Role Reward Fixes 2024-04-03 13:48:22 -04:00
handlers Format code 2024-04-05 08:06:44 -04:00
lib Merge branch 'dev' into 'main' 2024-03-29 17:26:44 +00:00
modules Format code 2024-04-05 08:06:44 -04:00
services Format code 2024-04-05 08:06:44 -04:00
.env.template Attempt to fix CD 2024-03-20 13:23:28 +01:00
.gitignore Update .gitignore 2024-03-07 13:19:41 -05:00
.gitlab-ci.yml Attempt to fix CD 2024-03-20 13:33:29 +01:00
docker-compose.yml Don't expose DB ports 2024-04-06 06:52:51 -04:00
Dockerfile Rename main.py to Racu.py 2024-04-06 06:23:40 -04:00
LICENSE Update LICENSE to MIT 2024-03-26 00:12:10 +00:00
nginx-template.html Add webpage template to repository 2024-04-06 08:11:07 -04:00
Racu.py Rename main.py to Racu.py 2024-04-06 06:23:40 -04:00
README.md Fix references in README 2024-04-05 08:05:13 -04:00
requirements.txt Update requirements versions 2024-04-05 06:07:42 -04:00
users.yml.example Add Dozzle examples 2024-03-01 12:37:13 +01:00

README.md

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

Racu art

Self-host

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

Installation

Racu is containerized: its core, database, database admin platform and logger run on Docker without any extra configuration. However, you CAN run it locally without Docker by hosting MariaDB on your machine with the login credentials specified in .env and installing Python 3.11 with the required pip packages. Note: I won't explain how to do this. Figure it out on your own.

git clone https://gitlab.com/wlinator/racu && cd racu

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

Optional: copy users.yml.example to users.yml to properly configure Dozzle logs. Check the file for more information.

docker compose up -d --build

Environment variables

  • TOKEN: your Discord Bot Token, you can get this here.

  • INSTANCE: this can be anything, only set it as "MAIN" if you've configured Dropbox backups.

  • OWNER_ID: the Discord user ID of the person who will act as owner of this bot.

  • XP_GAIN_PER_MESSAGE: how much XP should be awarded to a user per message.

  • XP_GAIN_COOLDOWN: XP earning cooldown time in seconds.

  • The values with "DBX" can be ignored unless you plan to make database backups with Dropbox. In that case enter your Dropbox API credentials.

  • MARIADB_USER: the username for your MariaDB database.

  • MARIADB_PASSWORD: the password for your database.

  • MARIADB_ROOT_PASSWORD: the root password for your database. (can be ignored unless you have a specific use for it)

Some icons used in Racu are provided by Icons8.