shockrah/clippable
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
168 Commits 1 Branch 0 Tags 3.4 MiB
CSS 45.9%
JavaScript 28.5%
TypeScript 15%
Shell 4.4%
Rust 3.4%
Other 2.8%
63ac49de5f
Go to file
shockrah 63ac49de5f + Upload form hooks for simple uploads 
There is still more work to be done for
stabilization as well as updates for more
code quality as right now things are very
ad-hoc.
2022-03-24 19:58:20 -07:00
api + Generally useful helper functions 2022-03-22 22:09:43 -07:00
aws * Fix to make syntax checks actually pass in testing 2022-01-02 17:15:50 -08:00
gitpage * Documentation now reflects project's current state 2021-10-23 00:14:41 -07:00
scripts *+ More env flags listed in readme 2022-01-28 13:39:19 -08:00
ts + Upload form hooks for simple uploads 2022-03-24 19:58:20 -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 + /admin/remove-video... 2022-03-22 22:09:04 -07:00
.gitlab-ci.yml +! More fixing of dev dependencies 2022-03-22 17:35:03 -07:00
.gitmodules + Gitpage with hugo 2021-10-16 21:11:09 -07:00
Dockerfile + DOcker image in registry wew lad 2021-10-18 02:18:00 -07:00
readme.md *+ More env flags listed in readme 2022-01-28 13:39:19 -08: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

  • SITE_NAME: default = Clippable

  • SITE_DESC: default = Short clips

  • SITE_URL: default = #

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.