1
Fork 0
mirror of https://github.com/wlinator/luminara.git synced 2024-10-02 22:23:13 +00:00

refactor: Update README.md with self-hosting instructions and requirements

This commit is contained in:
wlinator 2024-07-19 18:00:15 -04:00
parent 51343f0257
commit ddd2e41cd8

View file

@ -2,6 +2,43 @@
![Lumi art](https://git.wlinator.org/assets/img/logo.png) ![Lumi art](https://git.wlinator.org/assets/img/logo.png)
## 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.
### 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](https://git.wlinator.org/Luminara/Lumi/src/branch/main/docker-compose.prod.yml) to a new file named `docker-compose.yml` in an empty directory.
2. Copy the `.env.example` file 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 the Luminara bot in detached mode.
--- ---
Some icons used in Lumi are provided by [Icons8](https://icons8.com/). Some icons used in Lumi are provided by [Icons8](https://icons8.com/).