Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Building

Build Requirements

  • rustup
  • esbuild
  • nasm
  • meson
  • ninja
  • cmake
  • dav1d

Runtime Requirements

  • fontconfig (unless font path is manually specified)
  • ffmpeg (if transcodeing or chapter previews are desired)
  • Default Fonts: Cantarell VF, OpenSans Condensed ExtraBold, Noto Color Emoji

Jellything was only tested on x86_64-unknown-linux-gnu and aarch64-unknown-linux-gnu platforms; others likely work too.

Build Procedure

git clone --recursive https://codeberg.org/metamuffin/jellything.git
cd jellything
cargo build --release
# Global installation
install -Dm755 target/release/jellything /usr/local/bin/jellything
# OR: User installation
install -Dm755 target/release/jellything ~/.local/bin/jellything

Development / Debugging

There are compile-time features that improve debugging and development:

  • reload_css reads CSS files on every request (which normally requires compiling again)
  • reload_js recompiles JS files on every request (also usually requires compiling)
  • bypass_auth skips all authentication and always assumes an admin account. Useful for making requests with external tools that dont have cookies by default.

Jellything uses env_logger with configuration variable named LOG. Useful config could be LOG=info,jellyremuxer=debug etc.