mirror of
https://github.com/wlinator/luminara.git
synced 2024-10-02 18:23:12 +00:00
Update README for v3
This commit is contained in:
parent
8217a57610
commit
506911242e
1 changed files with 40 additions and 4 deletions
44
README.md
44
README.md
|
@ -1,11 +1,47 @@
|
|||
## Version 3 (Early Development)
|
||||
# You can invite me with [this link](https://discord.com/oauth2/authorize?client_id=1038050427272429588&permissions=8&scope=bot). Thanks for using Luminara!
|
||||
|
||||
Version 3 of Lumi is currently in early development. This new version will make the switch to `discord.py`.
|
||||
![Lumi art](https://git.wlinator.org/assets/img/logo.png)
|
||||
|
||||
### Self-Hosting
|
||||
## Self-Hosting
|
||||
|
||||
While v3 is still in development, you can self-host the bot using the provided `docker-compose.dev.yml` file. Please note that this version is not yet stable and may contain bugs or incomplete features.
|
||||
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 the contents from [`docker-compose.prod.yml`](docker-compose.prod.yml) to a new file named `docker-compose.yml`
|
||||
in an empty directory.
|
||||
|
||||
2. Copy the contents from [`.env.example`](.env.example) to a new file named `.env` in the same directory.
|
||||
|
||||
3. Fill out the `.env` file 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.
|
||||
|
||||
---
|
||||
|
||||
|
|
Loading…
Reference in a new issue