diff --git a/bazarr/README.md b/bazarr/README.md index 83a85e2b6..f1c19c6f8 100644 --- a/bazarr/README.md +++ b/bazarr/README.md @@ -6,30 +6,21 @@ ![Supports Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] -![Supports smb mounts][smb-shield] +![Supports smb mounts][smb-shield] # 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 -# 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) -[![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. Open the webUI and adapt the software options - # Configuration --------------- -Webui can be found at . -The default username/password : described in the startup log. + +--- + +Webui can be found at . +The default username/password : described in the startup log. Configurations can be done through the app webUI, except for the following options ```yaml @@ -42,11 +33,29 @@ cifsusername: "username" # optional, smb username, same for all smb shares cifspassword: "password" # optional, smb password ``` +# 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) + [![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. Open the webUI and adapt the software options + ## Support + Create an issue on github # Illustration --------------- + +--- + ![illustration](https://www.bazarr.media/assets/img/upgrade.png) [repository]: https://github.com/alexbelgium/hassio-addons @@ -55,5 +64,3 @@ Create an issue on github [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 - - diff --git a/cloudcommander/README.md b/cloudcommander/README.md index 78fa204ef..0bfaf6603 100644 --- a/cloudcommander/README.md +++ b/cloudcommander/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Cloudcommander + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white @@ -11,17 +12,6 @@ Cloud Commander a file manager for the web with console and editor. This addon is based on the [docker image](https://hub.docker.com/r/coderaiser/cloudcmd). -## 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. Install this add-on. -1. Click the `Save` button to store your configuration. -1. Start the add-on. -1. Check the logs of the add-on to see if everything went well. - ## Configuration Webui can be found at `:8000`. @@ -36,6 +26,17 @@ Webui can be found at `:8000`. "CUSTOM_OPTIONS": "--name Homeassistant" # custom options from https://cloudcmd.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. Install this add-on. +1. Click the `Save` button to store your configuration. +1. Start the add-on. +1. Check the logs of the add-on to see if everything went well. + [repository]: https://github.com/alexbelgium/hassio-addons [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/code-server/README.md b/code-server/README.md index 3f844e895..e286f84db 100644 --- a/code-server/README.md +++ b/code-server/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: code-server + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white @@ -12,6 +13,10 @@ Code-server is VS Code running on a remote server, accessible through the browse This addon is based on the [docker image](https://github.com/linuxserver/code-server) from linuxserver.io. +## Configuration + +Webui can be found at `:8443`. + ## Installation The installation of this add-on is pretty straightforward and not different in @@ -24,12 +29,6 @@ comparison to installing any other Hass.io 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. - -## Configuration - -Webui can be found at `:8443`. - - [repository]: https://github.com/alexbelgium/hassio-addons [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/doublecommander/README.md b/doublecommander/README.md index eae4e227f..7627323e4 100644 --- a/doublecommander/README.md +++ b/doublecommander/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: doublecommander + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white @@ -12,6 +13,10 @@ Double Commander is a free cross platform open source file manager with two pane This addon is based on the [docker image](https://github.com/linuxserver/docker-doublecommander) from linuxserver.io. +## Configuration + +Webui can be found at `:3000`. + ## Installation The installation of this add-on is pretty straightforward and not different in @@ -24,12 +29,6 @@ comparison to installing any other Hass.io 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. - -## Configuration - -Webui can be found at `:3000`. - - [repository]: https://github.com/alexbelgium/hassio-addons [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/emby/README.md b/emby/README.md index ee3a3302b..488026c72 100644 --- a/emby/README.md +++ b/emby/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: emby + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white @@ -9,6 +10,7 @@ ## About Forked to add latest beta versions, smb and local hdd mount. + - Inital version : https://github.com/petersendev/hassio-addons - CIFS code : https://github.com/dianlight/hassio-addons @@ -16,6 +18,10 @@ Forked to add latest beta versions, smb and local hdd mount. This addon is based on the [docker image](https://github.com/linuxserver/docker-emby) from linuxserver.io. +## Configuration + +Webui can be found at `:8096`. + ## Installation The installation of this add-on is pretty straightforward and not different in @@ -28,14 +34,7 @@ comparison to installing any other Hass.io 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. - -## Configuration - -Webui can be found at `:8096`. - [smb-shield]: https://img.shields.io/badge/SMB--green?style=plastic.svg - - [repository]: https://github.com/alexbelgium/hassio-addons [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/enedisGateway2MQTT/README.md b/enedisGateway2MQTT/README.md index 1ed5fef6c..e86a90c07 100644 --- a/enedisGateway2MQTT/README.md +++ b/enedisGateway2MQTT/README.md @@ -12,6 +12,11 @@ Enedisgateway2mqtt use Enedis Gateway API to send data in your MQTT Broker. See its github for all informations : https://github.com/m4dm4rtig4n/enedisgateway2mqtt/blob/master/README.md +### Configuration + +Configure the addon through its options page. +See this page for configuration : https://hub.docker.com/r/m4dm4rtig4n/enedisgateway2mqtt + ## Installation The installation of this add-on is pretty straightforward and not different in @@ -24,11 +29,6 @@ comparison to installing any other Hass.io 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. -### Configuration - -Configure the addon through its options page. -See this page for configuration : https://hub.docker.com/r/m4dm4rtig4n/enedisgateway2mqtt - [smb-shield]: https://img.shields.io/badge/SMB--green?style=plastic.svg [repository]: https://github.com/alexbelgium/hassio-addons [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg diff --git a/filebrowser/README.md b/filebrowser/README.md index 0ac20dd78..e0b1bc3d2 100644 --- a/filebrowser/README.md +++ b/filebrowser/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Filebrowser + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white @@ -8,9 +9,28 @@ ## About -Web based files browser. +Web based files browser. This addon is based on the [docker image](https://hub.docker.com/r/hurlenko/filebrowser) from hurlenko. +## Configuration + +Webui can be found at . +Default username: "admin" and password: "admin" + +Network disk is mounted to /share/storagecifs + +```yaml +ssl: true/false +certfile: fullchain.pem #ssl certificate +keyfile: privkey.pem #sslkeyfile +NoAuth: true/false #Remove password. Resets database when changed. +smbv1: false # Should smbv1 be used instead of 2.1+? +localdisks: sda1 #put the hardware name of your drive to mount separated by commas. Ex: sda1, sdb1... +networkdisks: "//SERVER/SHARE" # optional, list of smbv2/3 servers to mount, separated by commas +cifsusername: "username" # optional, smb username, same for all smb shares +cifspassword: "password" # optional, smb password, same for all smb shares) +``` + ## Installation The installation of this add-on is pretty straightforward and not different in @@ -23,26 +43,9 @@ comparison to installing any other Hass.io 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. -## Configuration -Webui can be found at . -Default username: "admin" and password: "admin" - -Network disk is mounted to /share/storagecifs - -```yaml -ssl: true/false -certfile: fullchain.pem #ssl certificate -keyfile: privkey.pem #sslkeyfile -NoAuth: true/false #Remove password. Resets database when changed. -smbv1: false # Should smbv1 be used instead of 2.1+? -localdisks: sda1 #put the hardware name of your drive to mount separated by commas. Ex: sda1, sdb1... -networkdisks: "//SERVER/SHARE" # optional, list of smbv2/3 servers to mount, separated by commas -cifsusername: "username" # optional, smb username, same for all smb shares -cifspassword: "password" # optional, smb password, same for all smb shares) -``` - ## Support -Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-filebrowser/282108/3) + +Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-filebrowser/282108/3) [repository]: https://github.com/alexbelgium/hassio-addons [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg