mirror of
https://github.com/wlinator/luminara.git
synced 2024-10-02 20:43:12 +00:00
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# You can invite me with [this link](https://discord.com/oauth2/authorize?client_id=1038050427272429588&permissions=8&scope=bot). Thanks for using Luminara!
|
|
|
|
|
|
|
|
## 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](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:
|
|
|
|
- [Docker](https://docs.docker.com/get-docker/)
|
|
- [Docker Compose](https://docs.docker.com/compose/install/)
|
|
|
|
Additionally, you'll need to create a Discord bot application and obtain a token:
|
|
|
|
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications).
|
|
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`](docker-compose.prod.yml), [`settings.yaml`](settings.yaml), and [`.env.example`](.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](https://icons8.com/).
|