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

chore: Refactor README.md to remove self-hosting instructions and outdated information

Browse source
This commit is contained in:
wlinator 2024-07-14 12:07:31 -04:00
parent edc734b1fa
commit 3f8b78f56a
1 changed files with 0 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -2,57 +2,6 @@
![Lumi art](https://git.wlinator.org/assets/img/logo.png)
## Self-host
**The next part of this README explains how to self-host Lumi, this allows you to host your own version of my code and
create a personalized Discord bot.**
**Note: because the `.slots` and `.blackjack` commands use custom (animated) emoji, these commands will break when you
self-host Lumi. Please replace the ID values in `config/JSON/resources.json` with your own set of emotes.**
### Installation
#### Docker
Lumi comes containerized with essential components such as MariaDB, its core application and Adminer.
To install Lumi, run these commands:
```bash
git clone https://git.wlinator.org/Luminara/Lumi && cd Lumi
```
Copy `.env.template` to `.env` and fill out the [variables](#environment-variables-env).
```bash
docker compose up -d --build
```
Please note that it's highly recommended to establish a reverse proxy setup for Adminer, ensuring better security and
accessibility.
- Adminer should be directed to port 8080.
#### Alternative
You can run Lumi without Docker, however I don't provide support or documentation for this. Here are some requirements
to get you started.
- MariaDB server on port 3306.
- Python 3.11 with the [required pip packages](requirements.txt).
- See the environment variables in [docker-compose.yml](docker-compose.yml) and set them manually.
## Environment variables (.env)
- `TOKEN`: your Discord Bot Token, you can get this [here](https://discord.com/developers/applications).
- `DBX_*`: set these up if you want to make database backups to your Dropbox app.
- `MARIADB_USER`: the username for your MariaDB database.
- `MARIADB_PASSWORD`: the password for your database.
- `MARIADB_ROOT_PASSWORD`: can be ignored unless you have a specific use for it.
- `MARIADB_DATABASE`: the name of your database.
Other variables can be specified in `docker.compose.yml` (core)
---
Some icons used in Lumi are provided by [Icons8](https://icons8.com/).