https://github.com/soerenschneider/fetcharr

Fetch loot from a seedbox
https://github.com/soerenschneider/fetcharr

lidarr prowlarr radarr rsync seedbox sonarr ssh

Last synced: 5 months ago
JSON representation

Fetch loot from a seedbox

• Host: GitHub
• URL: https://github.com/soerenschneider/fetcharr
• Owner: soerenschneider
• Created: 2023-12-04T19:25:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-29T04:06:02.000Z (5 months ago)
• Last Synced: 2025-04-29T05:19:47.367Z (5 months ago)
• Topics: lidarr, prowlarr, radarr, rsync, seedbox, sonarr, ssh
• Language: Go
• Homepage:
• Size: 158 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# fetcharr

[![Go Report Card](https://goreportcard.com/badge/github.com/soerenschneider/fetcharr)](https://goreportcard.com/report/github.com/soerenschneider/fetcharr)

![test-workflow](https://github.com/soerenschneider/fetcharr/actions/workflows/test.yaml/badge.svg)

![release-workflow](https://github.com/soerenschneider/fetcharr/actions/workflows/release-container.yaml/badge.svg)

![golangci-lint-workflow](https://github.com/soerenschneider/fetcharr/actions/workflows/golangci-lint.yaml/badge.svg)

Fetcharr is a [daemon](https://en.wikipedia.org/wiki/Daemon_(computing)) running on your local fileserver to fetch data from a remote [seedbox](https://en.wikipedia.org/wiki/Seedbox).

## Features

🪆 A powerful wrapper around rsync (or any other command) to fetch data from remote systems


🔌 Multiple pluggable event notifiers that invoke sync process (Kafka, RabbitMQ, webhooks, time-based)


🪝 Support for defining multiple pre- and post-hooks


🔭 Observability through Prometheus metrics


## Why would I need this?

🔨 You want to fetch data from a seedbox as soon as data has been downloaded successfully


📊 You want to get alerted on errors and look at dashboards rather than logs


## Deployment Overview

![bla](docs/diagrams/deployment.svg)

## Installation

### Requirements

- You need to have a seedbox / remote system that you can access via SSH. Authentication via ssh keys is required.

- The remote system needs to have rsync installed

- (If you want to use the example webhook script below, you also need to have curl installed. This should be the default on almost all distros.)

### Docker / Podman

````shell

$ git clone https://github.com/soerenschneider/fetcharr

$ cd fetcharr

$ docker run -v $(pwd)/contrib:/config ghcr.io/soerenschneider/fetcharr -config /config/fetcharr.yaml

````

### Binaries

Head over to the [prebuilt binaries](https://github.com/soerenschneider/fetcharr/releases) and download the correct binary for your system.

Use the example [systemd service file](contrib/fetcharr.service) to run it at boot.

### From Source

As a prerequesite, you need to have [Golang SDK](https://go.dev/dl/) installed. After that, you can install fetcharr from source by invoking:

```text

$ go install github.com/soerenschneider/fetcharr@latest

```

## Configuration

Head over to the [configuration section](docs/configuration.md) to see more details.

## Observability

Head over to the [metrics](docs/metrics.md) to see more details.

## Adding a webhook to Transmission

A guide that explains how to make Transmission call fetcharr's webhook endpoint can be found [here](docs/guides/adding-transmission-webhook.md).

## Changelog

The changelog can be found [here](CHANGELOG.md)