From fc9263dc81a37dd11e828aa9c5242db3e9bc6a61 Mon Sep 17 00:00:00 2001 From: kieran Date: Tue, 14 May 2024 11:27:54 +0100 Subject: [PATCH] Add running examples --- Dockerfile | 3 +-- README.md | 20 +++++++++++++++++++- config.prod.toml | 17 +++++++++++++++++ docker-compose.prod.yml | 21 +++++++++++++++++++++ 4 files changed, 58 insertions(+), 3 deletions(-) create mode 100644 config.prod.toml create mode 100644 docker-compose.prod.yml diff --git a/Dockerfile b/Dockerfile index 8787454..84465bd 100644 --- a/Dockerfile +++ b/Dockerfile @@ -37,6 +37,5 @@ RUN apt update && \ rm -rf /var/lib/apt/lists/* COPY --from=build /app/build . COPY --from=build /app/src/ui ui -COPY --from=build /app/src/config.toml . COPY --from=build /app/ffmpeg/lib/ /lib -ENTRYPOINT ["/app/bin/void_cat"] \ No newline at end of file +ENTRYPOINT ["./bin/void_cat"] \ No newline at end of file diff --git a/README.md b/README.md index 8b70b54..9087a3e 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,22 @@ Image hosting service - Blurhash calculation (NIP-96) ## Planned -- Torrent seed V2 \ No newline at end of file +- Torrent seed V2 + +## Running + +### Docker Compose +The easiest way to run `void-cat-rs` is to use `docker compose` + +```bash +docker compose -f docker-compose.prod.yml up +``` +### Manual +Assuming you already created your `config.toml` and configured the `database` run: +```bash +docker run --rm -it \ + -p 8000:8000 \ + -v ./config.toml:/app/config.toml \ + -e "RUST_LOG=info" \ + voidic/void-cat-rs +``` \ No newline at end of file diff --git a/config.prod.toml b/config.prod.toml new file mode 100644 index 0000000..0e503bc --- /dev/null +++ b/config.prod.toml @@ -0,0 +1,17 @@ +# Listen address for webserver +listen = "0.0.0.0:8000" + +# Database connection string (MYSQL) +database = "mysql://root:root@db:3306/void_cat" + +# Directory to store uploads +storage_dir = "/app/data" + +# Maximum support filesize for uploading +max_upload_bytes = 104857600 + +# Public facing url +public_url = "http://localhost:8000" + +# Whitelisted pubkeys, leave out to disable +# whitelist = ["63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed"] \ No newline at end of file diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml new file mode 100644 index 0000000..c60c3c1 --- /dev/null +++ b/docker-compose.prod.yml @@ -0,0 +1,21 @@ +volumes: + db: + files: +services: + db: + image: mariadb + environment: + - "MARIADB_ROOT_PASSWORD=root" + - "MARIADB_DATABASE=void_cat" + volumes: + - "db:/var/lib/mysql" + app: + image: voidic/void-cat-rs + #build: . + environment: + - "RUST_LOG=info" + ports: + - "8000:8000" + volumes: + - "files:/app/data" + - "./config.prod.toml:/app/config.toml" \ No newline at end of file