Remove old README
This commit is contained in:
parent
4618437981
commit
98c30a6014
45
README.md
45
README.md
@ -1,45 +0,0 @@
|
||||
# Veloren Group Bot
|
||||
|
||||
Group management bot for [Veloren](https://veloren.net)
|
||||
|
||||
## Usage
|
||||
|
||||
If you choose to run this but with Docker or Podman, you only need to create a local config.toml.
|
||||
But if you choose to compile you must clone this repository.
|
||||
|
||||
### Step 1: Create config.toml
|
||||
|
||||
Create a config.toml file in the project root.
|
||||
|
||||
```toml
|
||||
# config.toml
|
||||
username = "YOUR_USERNAME"
|
||||
password = "YOUR_PASSWORD"
|
||||
admin_list = []
|
||||
ban_list = []
|
||||
```
|
||||
|
||||
### Step 2: Run via Docker/Podman
|
||||
|
||||
Use Podman (or Docker) to run the release build without exposing secrets. First, create the secret.
|
||||
|
||||
```sh
|
||||
podman secret create config.toml config.toml
|
||||
```
|
||||
|
||||
Then run the container.
|
||||
|
||||
```sh
|
||||
podman run \
|
||||
--secret config.toml \
|
||||
--env CONFIG_PATH=/run/secrets/config.toml \
|
||||
git.jeffa.io/jeff/group_bot
|
||||
```
|
||||
|
||||
### Step 2 (Alternate): Run via cargo
|
||||
|
||||
Install [rustup](https://rustup.sh) and use cargo to compile and run the bot.
|
||||
|
||||
```sh
|
||||
CONFIG_PATH=config.toml cargo run
|
||||
```
|
Loading…
Reference in New Issue
Block a user