mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 18:01:03 +01:00
Update README.md
This commit is contained in:
@@ -1 +1,54 @@
|
||||
|
||||
# Home assistant add-on: Prowlarr
|
||||
![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
|
||||
![Supports smb mounts][smb-shield]
|
||||
|
||||
# About
|
||||
----------
|
||||
[Prowlarr](https://github.com/Prowlarr/Prowlarr) is an indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps.
|
||||
This addon is based on the docker image https://github.com/linuxserver/docker-prowlarr
|
||||
|
||||
# Installation
|
||||
----------
|
||||
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
||||
|
||||
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
||||
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
||||
1. Install this add-on.
|
||||
1. Click the `Save` button to store your configuration.
|
||||
1. Set the add-on options to your preferences
|
||||
1. Start the add-on.
|
||||
1. Check the logs of the add-on to see if everything went well.
|
||||
1. Open the webUI and adapt the software options
|
||||
|
||||
# Configuration
|
||||
--------------
|
||||
Webui can be found at <http://your-ip:PORT>.
|
||||
The default username/password : described in the startup log.
|
||||
Configurations can be done through the app webUI, except for the following options
|
||||
|
||||
```yaml
|
||||
GUID: user
|
||||
GPID: user
|
||||
TZ: timezone
|
||||
localdisks: "sda1, sdb1" # Optional
|
||||
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
|
||||
cifsusername: "username" # optional, smb username, same for all smb shares
|
||||
cifspassword: "password" # optional, smb password
|
||||
```
|
||||
|
||||
## Support
|
||||
Create an issue on github
|
||||
|
||||
# Illustration
|
||||
--------------
|
||||

|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg
|
||||
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user