Skip to content

Commit

Permalink
🎉 Release of add-on Whisparr 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
addonsbot committed Jan 13, 2024
1 parent be01813 commit 0a25e7a
Show file tree
Hide file tree
Showing 7 changed files with 174 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,19 @@ Open source password management solution

[:books: Vaultwarden (Bitwarden) add-on documentation][addon-doc-bitwarden]

### ✓ [Whisparr][addon-whisparr]

![Latest Version][whisparr-version-shield]
![Supports armhf Architecture][whisparr-armhf-shield]
![Supports armv7 Architecture][whisparr-armv7-shield]
![Supports aarch64 Architecture][whisparr-aarch64-shield]
![Supports amd64 Architecture][whisparr-amd64-shield]
![Supports i386 Architecture][whisparr-i386-shield]

Whisparr is an adult video collection manager for Usenet and BitTorrent users

[:books: Whisparr add-on documentation][addon-doc-whisparr]

### ✓ [WireGuard][addon-wireguard]

![Latest Version][wireguard-version-shield]
Expand Down Expand Up @@ -684,6 +697,7 @@ on the correct GitHub repository matching the add-on.
- [Open an issue for the add-on: UniFi Network Application][unifi-issue]
- [Open an issue for the add-on: Uptime Kuma][uptime-kuma-issue]
- [Open an issue for the add-on: Vaultwarden (Bitwarden)][bitwarden-issue]
- [Open an issue for the add-on: Whisparr][whisparr-issue]
- [Open an issue for the add-on: WireGuard][wireguard-issue]
- [Open an issue for the add-on: Z-Wave JS UI][zwave-js-ui-issue]
- [Open an issue for the add-on: ZeroTier One][zerotier-issue]
Expand Down Expand Up @@ -1078,6 +1092,15 @@ SOFTWARE.
[bitwarden-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
[bitwarden-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[bitwarden-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[addon-whisparr]: https://github.com/hassio-addons/addon-whisparr/tree/v0.1.0
[addon-doc-whisparr]: https://github.com/hassio-addons/addon-whisparr/blob/v0.1.0/README.md
[whisparr-issue]: https://github.com/hassio-addons/addon-whisparr/issues
[whisparr-version-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg
[whisparr-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[whisparr-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[whisparr-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
[whisparr-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[whisparr-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[addon-wireguard]: https://github.com/hassio-addons/addon-wireguard/tree/v0.10.2
[addon-doc-wireguard]: https://github.com/hassio-addons/addon-wireguard/blob/v0.10.2/README.md
[wireguard-issue]: https://github.com/hassio-addons/addon-wireguard/issues
Expand Down
3 changes: 3 additions & 0 deletions whisparr/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## What’s changed

🎉 Initial add-on release 🎉
102 changes: 102 additions & 0 deletions whisparr/DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Home Assistant Community Add-on: Whisparr

Whisparr is an adult video collection manager for Usenet and BitTorrent users.

## Installation

The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.

1. Click the Home Assistant My button below to open the add-on on your Home
Assistant instance.

[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]

1. Click the "Install" button to install the add-on.
1. Start the "Whisparr" add-on
1. Check the logs of the "Whisparr" add-on to see if everything went well.
1. Click "OPEN WEB UI" to open the Whisparr interface.
1. Complete the wizard shown on screen.

## Configuration

_This add-on does not require any configuration to run._

## Known issues and limitations

- This add-on does not support Home Assistant's Ingress feature (aka, the
toggle that puts an add-on in the Home Assistant sidebar).
There are too many variables to take into account to make this work properly,
and if we would, it would be very easy to break. You could consider using an
iframe panel instead.

## Changelog & Releases

This repository keeps a change log using [GitHub's releases][releases]
functionality.

Releases are based on [Semantic Versioning][semver], and use the format
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
based on the following:

- `MAJOR`: Incompatible or major changes.
- `MINOR`: Backwards-compatible new features and enhancements.
- `PATCH`: Backwards-compatible bugfixes and package updates.

## Support

Got questions?

You have several options to get them answered:

- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
support and feature requests.
- The [Home Assistant Discord chat server][discord-ha] for general Home
Assistant discussions and questions.
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]

You could also [open an issue here][issue] GitHub.

## Authors & contributors

The original setup of this repository is by [Franck Nijhof][frenck].

For a full list of all authors and contributors,
check [the contributor's page][contributors].

## License

MIT License

Copyright (c) 2024 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_whisparr&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[contributors]: https://github.com/hassio-addons/addon-whisparr/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e
[discord]: https://discord.me/hassioaddons
[forum]: https://community.home-assistant.io/t/?u=frenck
[frenck]: https://github.com/frenck
[issue]: https://github.com/hassio-addons/addon-whisparr/issues
[reddit]: https://reddit.com/r/homeassistant
[releases]: https://github.com/hassio-addons/addon-whisparr/releases
[semver]: http://semver.org/spec/v2.0.0.html
26 changes: 26 additions & 0 deletions whisparr/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Home Assistant Community Add-on: Whisparr

[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]

[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]

Whisparr is an adult video collection manager for Usenet and BitTorrent users.

## About

[Whisparr] 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.

[Whisparr]: https://github.com/whisparr/whisparr

[discord-shield]: https://img.shields.io/discord/330944238910963714.svg
[discord]: https://discord.gg/c5DvZ4e
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/t/?u=frenck
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[release-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg
[release]: https://github.com/hassio-addons/addon-whisparr/tree/v0.1.0
20 changes: 20 additions & 0 deletions whisparr/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Whisparr
version: 0.1.0
slug: whisparr
description: Whisparr is an adult video collection manager for Usenet and BitTorrent
users
url: https://github.com/hassio-addons/addon-whisparr/tree/main/README.md
codenotary: [email protected]
webui: http://[HOST]:[PORT:6969]
init: false
arch:
- aarch64
- amd64
- armv7
map:
- addon_config:rw
- share:rw
- media:rw
ports:
6969/tcp: 6969
image: ghcr.io/hassio-addons/whisparr/{arch}
Binary file added whisparr/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added whisparr/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0a25e7a

Please sign in to comment.