docs(info): add installation and config in readme

This commit is contained in:
Anhgelus Morhtuuzh 2024-04-18 00:39:58 +02:00
parent f8fd981793
commit df321f8795
No known key found for this signature in database
GPG key ID: CF4550297832A29F

View file

@ -18,6 +18,83 @@ message (number of different rune)
- $level^{-1}(x)=(5x)^2$ where $x$ is the level - $level^{-1}(x)=(5x)^2$ where $x$ is the level
- $lose(x,y)= x^2\cdot 10^{-2+\ln(x/85)}\cdot\lfloor y/500 +1 \rfloor$ where $x$ is the inactivity time (hour) and $y$ is the xp - $lose(x,y)= x^2\cdot 10^{-2+\ln(x/85)}\cdot\lfloor y/500 +1 \rfloor$ where $x$ is the inactivity time (hour) and $y$ is the xp
## Installation
There are two ways to install the bot: docker and build.
### Docker
1. Clone the repository
```bash
$ git clone https://github.com/anhgelus/les-copaings-bot.git
```
2. Go into the repository, rename `.env.example` into `.env` and customize it: add your token, change the user and the
password of the database
3. Start the compose file
```bash
$ docker compose up -d --build
```
Now you have to edit `config/config.toml`.
You can understand how this config file works below.
After editing this file, you have to start again the bot.
Every time you edit this file, you must restart the bot.
You can stop the compose file with `docker compose down`
### Build
1. Clone the repository
```bash
$ git clone https://github.com/anhgelus/les-copaings-bot.git
```
2. Install Go 1.22+
3. Go into the repository and build the program
```bash
$ go build .
```
4. Run the application through bash (or PowerShell if you are on Windows)
Now you have to edit `config/config.toml`.
You can understand how this config file works below.
After editing this file, you have to start again the bot.
Every time you edit this file, you must restart the bot.
## Config
The main config file is `config/config.toml`.
The default configuration is
```toml
debug = false
author = "anhgelus"
[redis]
address = "localhost:6379"
password = ""
db = 0
[database]
host = "localhost"
user = ""
password = ""
db_name = ""
port = 5432
```
- `debug` is true if the bot is in debug mode (don't turn it on unless you are modifying the source code)
- `author` is the author's name
- `[redis].address` is the address of redis (using docker, it's `redis:6379`)
- `[redis].password` is the redis's password
- `[redis].db` is the db to use
- `[database].host` is the host of postgres (using docker, it's `postgres`)
- `[database].user` is the user of postgres to use (using docker, it must be the same value as `POSTGRES_USER` in `.env`)
- `[database].password` is the user's password of postgres to use (using docker, it must be the same value as
`POSTGRES_PASSWORD` in `.env`)`
- `[database].db_name` is the postgres's database name to use (using docker, it must be the same value as `POSTGRES_DB`
in `.env`)
- `[database].port` is the port of postgres to use (using docker, it's `5432`)
## Technologies ## Technologies
- Go 1.22 - Go 1.22