Skip to content

nfrederick023/better-clipface

Repository files navigation

Watch page

Better Clipface is a fork of Clipface with an improved UI/UX and greater functionality.

Features

  • Video thumbnail generation
  • Search with real-time results
  • Simple user interface with light and dark mode support
  • Embed support for sites such as Twitter, Discord, etc.
  • "Favorites" so the best videos are always easy to find

Preview

Watch page

Video list

Getting Started

Using Docker

docker run -d --restart unless-stopped \
  --name better-clipface \
  -v /host/path/to/directory:/data \
  -p 3535:80 \
  -e PASSWORD="password" \
  -e PAGE_TITLE="Title" \
  nfrederick023/better-clipface:latest

Configuration

Better Clipface uses node-config for configuration management. This means that Clipface can be configured using a config file or by setting environment variables (or both.) For Docker deployments, using environment variables is the most convenient option.

List of config parameters:

  • app_path - Path of the directory where Better Clipface will make it's files. A "videos" folder will be created and this is where you will want to place the video files you want Better Clipface to index.

    Default value: "/data"
    Environment variable: APP_PATH

  • page_title - Title displayed on the clip list page and in the browser tab.

    Default value: Better Clipface
    Environment variable: PAGE_TITLE

  • password - Used to protect your Better Clipface instance. By default this is enabled because there is another variable below which when disabled allows for a more secure way to have a public facing library.

    Default value: adminadmin
    Environment variable: PASSWORD

  • thumbnail_size - Used to adjust the size of the thumbnails generated. We recommend using a size that matches an aspect ratio of 16:9 as that is the aspect ratio of the viewport when embedded.

    Default value: 1280x720
    Environment variable: THUMBNAIL_SIZE

  • private_library - Used to adjust whether or not your entire library of videos can be publicly accessible. If set to false, users not logged in can view all of your videos, but cannot adjust the favorite or privacy status.

    Default value: true
    Environment variable: PRIVATE_LIBRARY

About

Self-hosted web application for sharing video clips

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages