nex/college-bot-v2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Activity Actions

Update README.md
All checks were successful
Build and Publish Jimmy.2 / build_and_publish (push) Successful in 7s
Details

Browse source
This commit is contained in:
Nexus 2024-05-06 02:20:00 +01:00
parent 71b8111b17
commit d27dabbc36
1 changed files with 64 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -40,18 +40,25 @@ This command is not suitable to be run on a low-power VPS
* 2+ CPU Cores
* 10GB+ disk
**Autoresponder**:
The autoresponder has a few features, but one you should keep in mind is automated transcoding. If you want to enhance the transcoding speed (and lower the load on your CPU), you should pass through /dev/dri to your docker container. Alternatively, you can disable/configure it in config.toml (see below).
If you are going to use transcoding with hardware acceleration (/dev/dri), you should have at least a 6th generation intel CPU (or any other CPU that has HEVC 8-bit/better acceleration).
**`/yt-dl`**:
Jimmy v2 features the yt-dl command also, however a lot of the youtube functionality will be hindered if you host the bot in a cloud server. It is recommended you either host jimmy on a homeserver, or proxy your cloud server back to your residential connection, so that google does not block you.
### Configuring
All possible configuration options are in `config.example.toml`. Copy this to `config.toml` and edit it, and off you pop.
### Running
`docker-compose.yml` is provided. Use `docker compose up`. The latest image will be built automatically.
`docker-compose.yml` is provided. Use `docker compose up`. The latest image will be pulled automatically.
To update the docker file, you should do the following steps:
As the image is quite large, and my upload speed is... not, you may want to build the image yourself.
```shell
$ docker compose down
$ git pull
$ docker compose up --build # --build required to force a rebuild
```
You can clone this repository, then run `docker built -t git.i-am.nexus/nex/college-bot:latest .`, and then `docker compose up -d` as normal.
Alternatively, you can edit the compose file, replacing `image:` with `build: .`.