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

Configuration

Below is an annotated config with all default values manually specified. Basically all configuration fields are optional.

base_path: . # shortcut for setting both db, cache and media paths
database_path: db # relative to base_path
cache_path: cachedb # relative to base_path

admin_password: admin
max_memory_cache_size: 100000000 # 100MB

ui:
    brand: "Jellything"
    slogan: "Somebody put a nice slogan here"
    favicon: null # path
    # TODO add logo option after refactor

    # Each font option comes with another field (font_path, bold_font_path, emoji_font_path) to specify the path directly that takes precendence and skips font resolution via fontconfig.
    font: Cantarell:variable=true # used for all interface text
    bold_font: Open Sans:weight=200:width=75 # used for fallback image backgrounds
    emoji_font: Noto Color Emoji:color=true # used for server-side emoji rendering in fallback images

import:
    media_path: media
    # Max. Parallelism when importing. Do note that import operations are often blocking on the network so increasing this value beyond the default has a positive effect.
    num_threads: <number of logical cores on host machine>
    # TODO add api/plugin config after refactor

stream:
    # Options to offer a codec for transcoding. Transcoding audio to opus is always enabled.
    offer_avc: false
    offer_hevc: false
    offer_vp8: false
    offer_vp9: false
    offer_av1: false
    transcoder:
        enable_rkmpp: false # only supported on RK35xx series chips with custom ffmpeg
        enable_rkrga: false # only supported on RK35xx series chips with custom ffmpeg
        use_svtav1: false # only supported on x86
        use_rav1e: false
        # Preset values default to ffmpeg's defaults
        svtav1_preset: null # 0..=13, high is fast
        rav1e_preset: null # 0..=10
        aom_preset: null # 0..=8, high is fast
        x264_preset: null