shockrah/clippable
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
129 Commits 1 Branch 0 Tags 3.4 MiB
CSS 45.8%
JavaScript 28.6%
TypeScript 15%
Shell 4.4%
Rust 3.5%
Other 2.7%
1e2ff50214
Go to file
shockrah 1e2ff50214 * breadcrumb navbar should make navigation easier now
2021-10-26 18:47:24 -07:00
api * breadcrumb navbar should make navigation easier now 2021-10-26 18:47:24 -07:00
aws * Fixing remaining paths in ansible deploy script 2021-10-22 23:52:18 -07:00
gitpage * Documentation now reflects project's current state 2021-10-23 00:14:41 -07:00
scripts * This patch is just an excuse to mention that the docker registry has been updated 2021-10-23 00:15:20 -07:00
ts Merge branch 'master' of gitlab.com:shockrah/clippable 2021-10-26 09:57:21 -07:00
.dockerignore * This patch is just an excuse to mention that the docker registry has been updated 2021-10-23 00:15:20 -07:00
.gitattributes * LFS installed for image tracking 2021-10-05 15:54:50 -07:00
.gitignore + More stuff to ignore for windows env 2021-10-25 22:01:21 -07:00
.gitlab-ci.yml * breadcrumb navbar should make navigation easier now 2021-10-26 18:47:24 -07:00
.gitmodules + Gitpage with hugo 2021-10-16 21:11:09 -07:00
Cargo.lock + Lazy static because we need to start caching 2021-10-22 23:11:24 -07:00
Cargo.toml + Lazy static because we need to start caching 2021-10-22 23:11:24 -07:00
Dockerfile + DOcker image in registry wew lad 2021-10-18 02:18:00 -07:00
readme.md + DOcker image in registry wew lad 2021-10-18 02:18:00 -07:00

readme.md

Clippable

A small self hostable alternative to streamable. Built with Rocket.rs

Testing

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

There are a few environment variables that can be configured:

  • CLIPS_DIR : default = /media/clips

  • THUMBS_DIR: default = /media/thumbnails

Building the backend

Currently the project relies on Rust Nightly to build due to a requirement in Rocket however as that framework moves to Rust Stable so to will this project.

Building frontend javascript

Currently the website's javascript is written in typescript then compiled to Javascript. The output directory is /api/static/js/ which means mkdir -p api/static/js 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.