Update README.md

This commit is contained in:
Alexandre
2021-10-10 07:29:49 +02:00
committed by GitHub
parent fc594f61c1
commit 32600122df

View File

@@ -1,35 +1,54 @@
# Home assistant add-on: bazarr
![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
# About
----------
[Bazarr](https://www.bazarr.media/) is a companion application to Sonarr and Radarr that manages and downloads subtitles based on your requirements.
This addon is based on the docker image https://github.com/linuxserver/docker-bazarr
Forked to add latest version, addition of OCR
# Installation
----------
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
- Inital version : https://github.com/petersendev/hassio-addons
[bazarr](https://github.com/bazarr/bazarr) - A fork of bazarr to work with movies like Couchpotato.
This addon is based on the [docker image](https://github.com/linuxserver/docker-bazarr) from linuxserver.io.
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
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)
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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. Carefully configure the add-on to your preferences, see the official documentation for for that.
1. Open the webUI and adapt the software options
## Configuration
# 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
Webui can be found at `<your-ip>:7878`.
```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
```
[repository]: https://github.com/petersendev/hassio-addons
## Support
Create an issue on github
# Illustration
--------------
![illustration](https://www.bazarr.media/assets/img/upgrade.png)
[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