-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
99 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
root: ./docs | ||
|
||
structure: | ||
readme: README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Introduction | ||
|
||
Welcome to the Fetcharr documentation. | ||
|
||
## Features | ||
|
||
- **Integrates with Sonarr and Radarr**. Easy setup with multiple Radarr and/or Sonarr instances. | ||
- **Customizable filter rules** to limit what instances can be used for what content. | ||
- **Cross-platform**. Works on both `amd64`, `arm` and `arm64`. | ||
- **Frequently syncs your watchlist** allowing users to watch content shortly after adding it. | ||
|
||
## Motivation | ||
|
||
One of the strongest motivations to make Fetcharr was to get a more customizable experience, than what other solutions could offer. Having one Sonarr/Radarr instance for English content and another for anime was the primary goal. | ||
|
||
## Contributing | ||
|
||
Fetcharr is a simple hobby project. It is not meant to be anything more than that. If you have an interest in contributing, we'd love to have you on board! | ||
|
||
But, it should be noted that Fetcharr is nowhere near the first iteration of this concept. Below are some projects that Fetcharr took inspiration from, which you should consider helping, as well: | ||
- [Overseerr](https://github.com/sct/overseerr), by [Ryan Cohen](https://github.com/sct) | ||
- [Watchlistarr](https://github.com/nylonee/watchlistarr), by [Nihal Mirpuri](https://github.com/nylonee) | ||
- [Recyclarr](https://github.com/recyclarr/recyclarr), by [Robert Dailey](https://github.com/rcdailey) | ||
|
||
All of the projects above are made by very smart people, who have contributed hundreds of hours of their own free time. Consider helping them out instead, if you're interested in contributing to open-source. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
{% hint style="warning" %} | ||
**Fetcharr is still early in development.** If you would like to help test the bleeding edge, please use the image **`fetcharr/fetcharr:develop`**! | ||
{% endhint %} | ||
|
||
## Docker | ||
|
||
{% hint style="warning" %} | ||
Be sure to replace `/path/to/appdata/config` with a valid host directory path. If the path is invalid, Fetcharr will not be able to start the container properly. | ||
{% endhint %} | ||
|
||
{% tabs %} | ||
{% tab title="Docker CLI" %} | ||
|
||
To start Fetcharr with Docker CLI, run the following command: | ||
|
||
```bash | ||
docker run -d \ | ||
--name fetcharr \ | ||
-e TZ=Europe/Copenhagen \ | ||
-v /path/to/appdata/config:/config \ | ||
--restart unless-stopped \ | ||
fetcharr/fetcharr:latest | ||
``` | ||
|
||
{% endtab %} | ||
|
||
{% tab title="Docker Compose" %} | ||
|
||
For a declarative approach to starting Fetcharr, you can use Docker Compose, with a `compose.yaml` like this: | ||
|
||
```yaml | ||
services: | ||
fetcharr: | ||
image: fetcharr/fetcharr:latest | ||
container_name: fetcharr | ||
environment: | ||
- TZ=Europe/Copenhagen | ||
volumes: | ||
- /path/to/appdata/config:/config | ||
restart: unless-stopped | ||
``` | ||
Then, to start Fetcharr: | ||
```bash | ||
docker-compose up -d | ||
``` | ||
|
||
{% endtab %} | ||
{% endtabs %} | ||
|
||
## From source | ||
|
||
{% hint style="danger" %} | ||
While building the project from source can be useful for trying out bleeding-edge features, **it is not recommended for production use.** | ||
{% endhint %} | ||
|
||
First, clone down the repository and checkout the branch you'd like to build: | ||
```bash | ||
git clone -b BRANCH_NAME https://github.com/fetcharr/fetcharr | ||
``` | ||
|
||
Afterwards, build the Docker image using [NUKE](https://nuke.build): | ||
```bash | ||
./build.cmd BuildImage # or `nuke BuildImage`, if you have it installed | ||
``` | ||
|
||
{% hint style="info" %} | ||
You don't need to have NUKE installed for `build.cmd` to work. | ||
{% endhint %} |
Empty file.
Empty file.
Empty file.