Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update whisparr.md #196

Merged
merged 1 commit into from
Mar 9, 2023
Merged

Update whisparr.md #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/sandbox/apps/whisparr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# whisparr

## THIS DOCUMENTATION IS NOT YET COMPLETED
# Whisparr

## What is it?

[whisparr](https://whisparr.url){: target=_blank rel="noopener noreferrer" } is a...
[Whisparr](https://wiki.servarr.com/whisparr){: target=_blank rel="noopener noreferrer" } is an adult movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available. Note that only one type of a given movie is supported. If you want both an 4k version and 1080p version of a given movie you will need multiple instances.

!!!info
By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into whisparr with the email and password you set up upon instalation.

| Details | | | |
|-------------|-------------|-------------|-------------|
| [:material-home: Project home](https://whisparr.url){: .header-icons target=_blank rel="noopener noreferrer" } | [:octicons-link-16: Docs](https://whisparr.docs.url){: .header-icons target=_blank rel="noopener noreferrer" } | [:octicons-mark-github-16: Github](https://github.com/whisparr/whisparr){: .header-icons target=_blank rel="noopener noreferrer" } | [:material-docker: Docker](https://hub.docker.com/r/whisparr/whisparr){: .header-icons target=_blank rel="noopener noreferrer" }|
| [:material-home: Project home](https://wiki.servarr.com/whisparr){: .header-icons target=_blank rel="noopener noreferrer" } | [:octicons-link-16: Docs](https://wiki.servarr.com/en/whisparr/quick-start-guide){: .header-icons target=_blank rel="noopener noreferrer" } | [:octicons-mark-github-16: Github](https://github.com/Whisparr/Whisparr){: .header-icons target=_blank rel="noopener noreferrer" } | [:material-docker: Docker](https://hub.docker.com/r/hotio/whisparr){: .header-icons target=_blank rel="noopener noreferrer" }|

### 1. Installation

Expand All @@ -22,6 +23,8 @@ sb install sandbox-whisparr

- To access whisparr, visit `https://whisparr._yourdomain.com_`

### 3. Usage
### 3. Setup

Whisparr works more or less the same as the other apps in the arr suite, since this is a fork of sonarr.

- Instructions for whisparr
- [:octicons-link-16: Documentation: Whisparr Docs](https://wiki.servarr.com/en/whisparr/quick-start-guide){: .header-icons target=_blank rel="noopener noreferrer" }