Luminara/Lumi
Luminara/Lumi
1
Fork 0
mirror of https://github.com/wlinator/luminara.git synced 2024-10-02 18:03:12 +00:00
Code Activity
Lumi/README.md
wlinator f73e7882de refactor: Update README
2024-09-02 06:37:50 -04:00

1.9 KiB
Raw Blame History

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

Lumi art

Self-Hosting

Self-hosting refers to running Luminara on your own server or computer, rather than using the publicly hosted version. This approach offers the ability to manage your own instance of the bot and give it a custom name and avatar.

Note: From v2.9.0 and onward, Lumi now utilizes a settings.yaml file to manage configuration settings. This allows you to customize your bot's behavior without needing to modify the source code itself.

Requirements

Before you begin, make sure you have the following installed on your system:

Additionally, you'll need to create a Discord bot application and obtain a token:

  1. Go to the Discord Developer Portal.
  2. Click on "New Application" and give it a name.
  3. Navigate to the "Bot" tab and click "Add Bot".
  4. Under the bot's username, click "Reset Token" to reveal your bot token.
  5. Copy this token; you'll need it for the .env file later.

Note: remember to keep your bot token secret and never share it publicly.

Running Luminara:

  1. Copy docker-compose.prod.yml, settings.yaml, and .env.example to an empty directory.

  2. Rename docker-compose.prod.yml to docker-compose.yml.

  3. Rename .env.example to .env and fill it out with your specific configuration details.

  4. Run the following command in your terminal:

    docker compose up -d --build

This will build and start Luminara in detached mode.

Some icons used in Lumi are provided by Icons8.