Remove redis dep, update docs

main
DaXcess 2023-03-03 14:14:53 +01:00
parent 6dc560a485
commit d857a3b72d
No known key found for this signature in database
GPG Key ID: CF78CC72F0FD5EAD
3 changed files with 7 additions and 2 deletions

View File

@ -71,6 +71,13 @@ If you are actively developing Spoticord, you can use the following command to b
cargo run cargo run
``` ```
# Features
As of now, Spoticord has one optional feature: `metrics`. This feature enables pushing metrics about the bot, like how many servers it is in, which tracks are being played and which commands are being executed. The metrics are designed to be pushed to a [Prometheus Pushgateway](https://prometheus.io/docs/instrumenting/pushing/). If you want to enable this feature, you can do so by running the following command:
```sh
cargo build --release --features metrics
```
# MSRV # MSRV
The minimum supported rust version is `1.64.0`. The minimum supported rust version is `1.64.0`.

View File

@ -20,7 +20,6 @@ lazy_static = { version = "1.4.0", optional = true }
librespot = { version = "0.4.2", default-features = false } librespot = { version = "0.4.2", default-features = false }
log = "0.4.17" log = "0.4.17"
prometheus = { version = "0.13.3", optional = true, features = ["push", "process"] } prometheus = { version = "0.13.3", optional = true, features = ["push", "process"] }
redis = "0.22.3"
reqwest = "0.11.14" reqwest = "0.11.14"
samplerate = "0.2.4" samplerate = "0.2.4"
serde = "1.0.152" serde = "1.0.152"

View File

@ -16,7 +16,6 @@ Spoticord uses environment variables to configure itself. The following variable
Additionally you can configure the following variables: Additionally you can configure the following variables:
- `GUILD_ID`: The ID of the Discord server where this bot will create commands for. This is used during testing to prevent the bot from creating slash commands in other servers, as well as getting the commands quicker. This variable is optional, and if not set, the bot will create commands in all servers it is in (this may take up to 15 minutes). - `GUILD_ID`: The ID of the Discord server where this bot will create commands for. This is used during testing to prevent the bot from creating slash commands in other servers, as well as getting the commands quicker. This variable is optional, and if not set, the bot will create commands in all servers it is in (this may take up to 15 minutes).
- `KV_URL`: The connection URL of a redis-server instance used for storing realtime data. While not required, not providing one will cause the bot to spit out quite a bit of errors. You might want to comment out those error lines in `main.rs`.
- `METRICS_URL`: The connection URL of a Prometheus Push Gateway server used for pushing metrics. This variable is required when compiling with the `metrics` feature. - `METRICS_URL`: The connection URL of a Prometheus Push Gateway server used for pushing metrics. This variable is required when compiling with the `metrics` feature.
#### Providing environment variables #### Providing environment variables