void-cat-rs/README.md
Kieran f9cdc6d85e
All checks were successful
continuous-integration/drone/push Build is passing
Update readme
closes #3
2024-08-30 19:58:36 +01:00

1.3 KiB

void-cat-rs

Image hosting service

Features

Planned

  • Torrent seed V2

Running

Docker Compose

The easiest way to run void-cat-rs is to use docker compose

docker compose -f docker-compose.prod.yml up

Manual

Assuming you already created your config.toml and configured the database run:

docker run --rm -it \
  -p 8000:8000 \
  -v ./config.toml:/app/config.toml \
  -e "RUST_LOG=info" \
  voidic/void-cat-rs

Building

Feature Flags

Default = nip96 & blossom

  • nip96: Enable NIP-96 support
  • blossom: Enable blossom support
  • labels: Enable AI image labeling (Depends on nip96)

Default build:

cargo build --release

Build only Blossom support

cargo build --release --no-default-features --features blossom

Build dependencies

If you want to support NIP-96 you will need the following dependencies:

libavcodec-dev libavformat-dev libswscale-dev libavutil-dev libavdevice-dev libavfilter-dev