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

Setting up Jellything

Installation

From the AUR

This is the recommended option. It will also install a systemd service and default config.

paru -S jellything-git
# OR
yay -S jellything-git
# OR
git clone https://aur.archlinux.org/jellything-git.git
cd jellything-git && makepkg -si

From Source

See Building.

Configuration

Jellything is configured with YAML. The recommended config path for a system installation (and the one used in the AUR package’s systemd service) is /etc/jellything.yaml but any other path will work just fine too.

All configuration options in Jellything have a sensible default value such that an empty file is a valid configuration. You might however want to change the following options in particular:

  • base_path Folder where database and cache are placed
  • import.media_path Root folder of your media hierarchy. (Default: <base_path>/media)

For advanced configuration see Configuration.

Running

jellything /etc/config.yaml