Getting started

Before describing how to get it running, let's describe in a few lines what flemzerd is about:

flemzerd is a tool that automates your media download process. It also can be used as a notifier for tracked shows.

The goal of this tool is to ease away the unpleasing following sequence of tasks:

• Watch regularly for each the TV shows you are watching if a new episode has aired
• Find a torrent for the episode
• Add torrent to your download client and look after the download
• When the download is finished, moved the downloaded files to where you store your media files
• Refresh your media center to see the downloaded files

• Download the latest release from GitHub: Releases
• Launch the install via the Makefile:

make install

• Download the latest release from GitHub: Releases
• Launch the install via the Makefile:

make update

Flemzerd acts as an orchestrator for different external services (download client, torrent indexer, watchlist). For flemzerd to function properly, all these services must be started and available from the server running flemzerd, and then configured into flemzerd.

The services/configuration needed are the following:

• A Watchlist (manual or via trakt.tv)
• A Provider (TMDB or TVDB with API key configured)
• A download client (transmission)
• (Optional) Notifiers (Telegram, Pushbullet)
• (Optional) A Media center (kodi)

More information about general concepts of flemzerd, configuration options and modules can be found of the rest of this documentation.

• Run with all dependencies preconfigured (recommended):

docker-compose up

• As a service (via systemctl)

systemctl start flemzerd

* To enable at startup

systemctl enable flemzerd

• As a standalone binary

/usr/bin/flemzerd -d

• As a docker image

docker run -v "/etc/flemzerd/flemzerd-docker.toml:/etc/flemzerd/flemzerd.toml" -v "/var/lib/flemzerd/db/:/var/lib/flemzerd/db" -v "/var/lib/flemzerd/tmp:/downloads" -it macarrie/flemzerd

If released packages are not for you (wrong architecture, want to follow latest dev), flemzerd can be built from source.

The following dependencies are needed:

• Go 1.11
• Nodejs
• npm
• Rust (for external dependency: Vidocq)

To build, simply use the Makefile:

make build

This will generate a package under the package/ folder, which is the same as the ones that can be downloaded as releases on Github. Install and update work as described previously.

With docker installed, build a docker image for the latest code with:

make docker