From de51b9141d99ebf1f291a1b8469e16e132c6c21e Mon Sep 17 00:00:00 2001 From: shockrah Date: Mon, 18 Oct 2021 02:18:00 -0700 Subject: [PATCH] + DOcker image in registry wew lad + Better docs All around qol for people that don't know what this thing is --- Dockerfile | 8 ++++++++ api/target/CACHEDIR.TAG | 3 --- readme.md | 17 +++++++++++------ scripts/default-rocket-toml.sh | 2 +- 4 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 Dockerfile delete mode 100644 api/target/CACHEDIR.TAG diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..2071b27 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,8 @@ +FROM debian:sid-slim + +# Default daniel dirs +RUN mkdir -p /media/clips /media/thumbnails +COPY build/ /app +WORKDIR /app +ENTRYPOINT [ "/app/server" ] + diff --git a/api/target/CACHEDIR.TAG b/api/target/CACHEDIR.TAG deleted file mode 100644 index 20d7c31..0000000 --- a/api/target/CACHEDIR.TAG +++ /dev/null @@ -1,3 +0,0 @@ -Signature: 8a477f597d28d172789f06886806bc55 -# This file is a cache directory tag created by cargo. -# For information about cache directory tags see https://bford.info/cachedir/ diff --git a/readme.md b/readme.md index 6e0bfca..5e2f987 100644 --- a/readme.md +++ b/readme.md @@ -2,10 +2,18 @@ A small self hostable alternative to streamable. Built with Rocket.rs -## Status +## Testing -Right now the public API is being built so that as long as there videos to serve -the application should serve +A docker container is provided: + +* `docker pull registry.gitlab.com/shockrah/clippable:latest` + +Below is the suggested way test things out + +* `docker run --rm -p 8482:8482 -it -v /path/to/clips:/media/clips -v /path/to/thumbnails:/media/thumbnails` + +**NOTE**: Without proper thumbnails you get the "404" gif everywhere but the +videos will still be there. ## Admin Setup/Configuration @@ -28,6 +36,3 @@ must be ran in order to ensure that output directory is present and compilation succeeds. There are no dependencies and is only written in typescript to enforce some level of consistency among contributor code. -## Roadmap - -_Check the /roadmap.md_ \ No newline at end of file diff --git a/scripts/default-rocket-toml.sh b/scripts/default-rocket-toml.sh index 1b50cf2..59fe496 100644 --- a/scripts/default-rocket-toml.sh +++ b/scripts/default-rocket-toml.sh @@ -8,7 +8,7 @@ port = 8482 keep_alive = 5 read_timeout = 5 write_timeout = 5 -log = "critical" +log_level = "critical" limits = { forms = 4096 } # Must be type (below is not valid toml syntax)