From e71ca26afc470de92741fb1009464466e2f61eb0 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Mon, 1 Nov 2021 22:33:35 +0100 Subject: [PATCH] Realign logic of titles --- README.md | 63 ++++++++++++++++++++++++++++-------- bazarr/README.md | 8 ++--- bitwarden/.README.j2 | 1 - bitwarden/DOCS.md | 10 +++--- enedisGateway2MQTT/README.md | 2 +- flexget/README.md | 3 +- grav/Readme.md | 12 ++++--- inadyn/README.md | 3 +- joal/README.md | 1 + joplin/README.md | 5 ++- lidarr/Readme.md | 40 ++++++++++++++--------- mealie/README.md | 4 ++- nextcloud/README.md | 8 ++--- organizr/README.md | 4 +++ papermerge/README.md | 1 + photoprism/README.md | 8 ++--- portainer/README.md | 34 ++++++++++++------- prowlarr/README.md | 41 +++++++++++++---------- qbittorrent/README.md | 46 ++++++++++++++++---------- radarr/README.md | 38 +++++++++++++--------- readarr/Readme.md | 10 +++--- requestrr/Readme.md | 8 ++--- resiliosync/README.md | 3 ++ scrutiny/README.md | 38 ++++++++++++++-------- sonarr/README.md | 41 +++++++++++++++-------- teamspeak/README.md | 2 ++ transmission/README.md | 16 +++++---- ubooquity/README.md | 22 +++++++++---- webtrees/README.md | 39 +++++++++++++--------- wger/README.md | 9 ++++-- 30 files changed, 334 insertions(+), 186 deletions(-) diff --git a/README.md b/README.md index ab87292ce..931ea99cf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Home assistant add-on: alexbelgium + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) -![update-badge] +![update-badge] [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white [update-badge]: https://img.shields.io/github/last-commit/alexbelgium/hassio-addons?label=last%20update @@ -31,111 +32,147 @@ https://github.com/alexbelgium/hassio-addons [//]: # "ADDONLIST_START" ### ✓ [Addons Updater](addons_updater/) ![support][support-shield] + Automatic addons update by aligning version tag with github upstream releases ### ✓ [Bazarr](bazarr/) ![smb][smb-shield] + Companion application to Sonarr and Radarr to download subtitles ### ✓ [Bitwarden](bitwarden/) + Open source password management solution ### ✓ [Code-server](code-server/) + Code-server is VS Code running on a remote server, accessible through the browser. ### ✓ [Doublecommander](doublecommander/) ![smb][smb-shield] + A free cross platform open source file manager with two panels side by side. ### ✓ [Emby](emby/) ![smb][smb-shield] + A Free Software Media System that puts you in control of managing and streaming your media. ### ✓ [Grav](grav/) ![smb][smb-shield] + Fast, Simple, and Flexible, file-based Web-platform -### ✓ [Filebrowser](filebrowser/) ![support][support-shield]![smb][smb-shield] +### ✓ [Filebrowser](filebrowser/) ![support][support-shield]![smb][smb-shield] + A file manager for the web ### ✓ [Flexget](flexget/) -FlexGet is a multipurpose automation tool for all of your media (Developed for @TyjTyj) + +FlexGet is a multipurpose automation tool for all of your media (Developed for @TyjTyj) ### ✓ [Inadyn](inadyn/) + Inadyn, or In-a-Dyn, is a small and simple Dynamic DNS, DDNS, client with HTTPS support. Commonly available in many GNU/Linux distributions, used in off the shelf routers and Internet gateways to automate the task of keeping your Internet name in sync with your public¹ IP address. It can also be used in installations with redundant (backup) connections to the Internet. ### ✓ [Jackett](jackett/) ![smb][smb-shield] + Translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software ### ✓ [Jellyfin](jellyfin/) ![smb][smb-shield] + A Free Software Media System that puts you in control of managing and streaming your media. ### ✓ [Joal](joal/) ![ingress][ingress-shield] + An open source command line RatioMaster with WebUI. ### ✓ [Mealie](mealie/) + Mealie is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family. This addon is based on the docker image from hay-kot. ### ✓ [Nextcloud OCR](nextcloud/) ![smb][smb-shield] + A Nextcloud container, brought to you by LinuxServer.io. ### ✓ [Ombi](ombi/) + Self-hosted Plex Request and user management system ### ✓ [Organizr](organizr/) + An HTPC/Homelab services organizer that is written in PHP ### ✓ [Papermerge](papermerge/) ![smb][smb-shield] + Open source document management system (DMS) ### ✓ [Photoprism](photoprism/) ![smb][smb-shield] ![sql][sql-shield] ![ram][ram-shield] + server-based application for browsing, organizing and sharing your personal photo collection ### ✓ [Piwigo](piwigo/) ![smb][smb-shield] ![sql][sql-shield] + photo gallery software for the web -### ✓ [Portainer](portainer/) ![privileged][privileged-shield] ![ingress][ingress-shield] +### ✓ [Portainer](portainer/) ![privileged][privileged-shield] ![ingress][ingress-shield] + Manage your docker environment -### ✓ [Plex](plex/) ![smb][smb-shield] +### ✓ [Plex](plex/) ![smb][smb-shield] + Plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. ### ✓ [Prowlarr](prowlarr/) ![smb][smb-shield] + Torrent Trackers and Usenet Indexers offering complete management ofSonarr, Radarr, Lidarr, and Readarr indexers with no per app setup required -### ✓ [Qbittorrent](qbittorrent/) ![smb][smb-shield] ![support][support-shield] ![ingress][ingress-shield] +### ✓ [Qbittorrent](qbittorrent/) ![smb][smb-shield] ![support][support-shield] ![ingress][ingress-shield] + Torrent manager with custom ui and many configurable options ### ✓ [Radarr](radarr/) ![smb][smb-shield] + A fork of Sonarr to work with movies like Couchpotato ### ✓ [Readarr](readarr/) ![smb][smb-shield] + Book Manager and Automation ### ✓ [Requestrr](requestrr/) + Chatbot used to simplify using services like Sonarr/Radarr/Ombi via the use of chat ### ✓ [Resioliosync](resiolosync/) ![smb][smb-shield] -Self-hosted file share and collaboration platform on the Web (dev by @TyjTyj) + +Self-hosted file share and collaboration platform on the Web (dev by @TyjTyj) ### ✓ [Sonarr](sonarr/) ![smb][smb-shield] + Can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. -### ✓ [Scrutiny](scrutiny/) ![support][support-shield] ![ingress][ingress-shield] +### ✓ [Scrutiny](scrutiny/) ![support][support-shield] ![ingress][ingress-shield] + Scrutiny WebUI for smartd S.M.A.R.T monitoring ### ✓ [Teamspeak](teamspeak/) + Voice communication for online gaming, education and training. ### ✓ [Transmission](transmission/) ![smb][smb-shield] + The torrent client for Hass.io. -### ✓ [Ubooquity](ubooquity/) ![smb][smb-shield] ![support][support-shield] ![ram][ram-shield] +### ✓ [Ubooquity](ubooquity/) ![smb][smb-shield] ![support][support-shield] ![ram][ram-shield] + Free, lightweight and easy-to-use home server for your comics and ebooks ### ✓ [Webtrees](webtrees/) -web's leading online collaborative genealogy application + +web's leading online collaborative genealogy application ### ✓ [Wger](wger/) -manage your personal workouts, weight and diet plans + +manage your personal workouts, weight and diet plans ### ✓ [xTeVe](xteve/) + M3U Proxy for Plex DVR and Emby Live TV. [//]: # "ADDONLIST_END" @@ -143,5 +180,5 @@ M3U Proxy for Plex DVR and Emby Live TV. [sql-shield]: https://img.shields.io/badge/SQL-external-orange.svg [privileged-shield]: https://img.shields.io/badge/privileged-required-orange.svg [ingress-shield]: https://img.shields.io/badge/ingress--green.svg -[support-shield]: https://img.shields.io/badge/Support-thread-green.svg -[ram-shield]: https://img.shields.io/badge/RAM_min-4Gb-orange.svg +[support-shield]: https://img.shields.io/badge/Support-thread-green.svg +[ram-shield]: https://img.shields.io/badge/RAM_min-4Gb-orange.svg diff --git a/bazarr/README.md b/bazarr/README.md index f1c19c6f8..9cfb8963d 100644 --- a/bazarr/README.md +++ b/bazarr/README.md @@ -8,14 +8,14 @@ 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 -# Configuration +## Configuration --- @@ -33,7 +33,7 @@ cifsusername: "username" # optional, smb username, same for all smb shares cifspassword: "password" # optional, smb password ``` -# Installation +## Installation --- @@ -52,7 +52,7 @@ The installation of this add-on is pretty straightforward and not different in c Create an issue on github -# Illustration +## Illustration --- diff --git a/bitwarden/.README.j2 b/bitwarden/.README.j2 index 8e7bcc397..c60c76700 100644 --- a/bitwarden/.README.j2 +++ b/bitwarden/.README.j2 @@ -82,4 +82,3 @@ If you are more interested in stable releases of our add-ons: [release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg [release]: {{ repo }}/tree/{{ version }} [screenshot]: {{ repo }}/raw/master/images/screenshot.png - diff --git a/bitwarden/DOCS.md b/bitwarden/DOCS.md index 9ba05a045..6ca7c642c 100644 --- a/bitwarden/DOCS.md +++ b/bitwarden/DOCS.md @@ -60,7 +60,7 @@ dealing with an unknown issue. Possible values are: - `debug`: Shows detailed debug information. - `info`: Normal (usually) interesting events. - `warning`: Exceptional occurrences that are not errors. -- `error`: Runtime errors that do not require immediate action. +- `error`: Runtime errors that do not require immediate action. - `fatal`: Something went terribly wrong. Add-on becomes unusable. Please note that each level automatically includes log messages from a @@ -113,12 +113,12 @@ functionality. The format of the log is based on [Keep a Changelog][keepchangelog]. Releases are based on [Semantic Versioning][semver], and use the format -of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +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. +- `MAJOR`: Incompatible or major changes. +- `MINOR`: Backwards-compatible new features and enhancements. +- `PATCH`: Backwards-compatible bugfixes and package updates. ## Support diff --git a/enedisGateway2MQTT/README.md b/enedisGateway2MQTT/README.md index e86a90c07..540d1dbe9 100644 --- a/enedisGateway2MQTT/README.md +++ b/enedisGateway2MQTT/README.md @@ -12,7 +12,7 @@ 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 +## Configuration Configure the addon through its options page. See this page for configuration : https://hub.docker.com/r/m4dm4rtig4n/enedisgateway2mqtt diff --git a/flexget/README.md b/flexget/README.md index b46860f96..756f5d742 100644 --- a/flexget/README.md +++ b/flexget/README.md @@ -8,13 +8,14 @@ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ## About + FlexGet is a multipurpose automation tool for all of your media. See https://flexget.com/ ## Requirements ## Config -WebuiPass - Password to access webui +WebuiPass - Password to access webui ## Start diff --git a/grav/Readme.md b/grav/Readme.md index 3f8e2b601..e604984ac 100644 --- a/grav/Readme.md +++ b/grav/Readme.md @@ -8,14 +8,14 @@ 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 --- [Grav](https://getgrav.org) is a free software, self-hosted content management system (CMS) written in the PHP programming language and based on the Symfony web application framework. It uses a flat file database for both backend and frontend. This addon is based on the docker image https://github.com/linuxserver/docker-grav -# Installation +## Installation --- @@ -30,16 +30,18 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI and adapt the software options -# Configuration +## Configuration 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 - + ## Add theme/squeleton + You can place the user folder from the theme/skeleton in /share/grav/www/user, ## Options + ```yaml GUID: user GPID: user @@ -54,7 +56,7 @@ cifspassword: "password" # optional, smb password Create an issue on github -# Illustration +## Illustration --- diff --git a/inadyn/README.md b/inadyn/README.md index d5f04a76c..81483ab32 100644 --- a/inadyn/README.md +++ b/inadyn/README.md @@ -31,8 +31,6 @@ comparison to installing any other Hass.io add-on. To configure with addon options, no webUI. For configuration, see https://github.com/troglobit/inadyn -### Configuration - The available configuration options are as follows (this is filled in with some example data): ``` @@ -95,6 +93,7 @@ or: ``` for a custom provider that is not supported by inadyn you can do: + ``` { "providers": [ diff --git a/joal/README.md b/joal/README.md index 42f358513..e4d254566 100644 --- a/joal/README.md +++ b/joal/README.md @@ -18,6 +18,7 @@ All credits for the app go to Anthony Raymond, please visit his repository here Joal configuration : in the addon log are all informations tailored for your system Addon options + ```yaml secret_token: lrMY24Byhx #you can encode your own token here that will be used to identify in the app ui_path: joal #the path where Joal will be accessible diff --git a/joplin/README.md b/joplin/README.md index 3587fd10c..1a2f5684d 100644 --- a/joplin/README.md +++ b/joplin/README.md @@ -12,7 +12,7 @@ Joplin Server is a free, open source note taking and to-do Sync application, which can handle a large number of notes organised into notebooks. With this server you can sync all your notes over all your devices. -Thanks to @poudenes for helping with the development! +Thanks to @poudenes for helping with the development! Project homepage : https://github.com/laurent22/joplin @@ -40,6 +40,7 @@ APP_BASE_URL: This is the base public URL where the service will be running. For To use an existing PostgresSQL server, set the following variables in the config: Make sure that the provided database and user exist as the server will not create them. + ``` DB_CLIENT=pg POSTGRES_PASSWORD=joplin @@ -48,7 +49,9 @@ POSTGRES_USER=joplin POSTGRES_PORT=5432 POSTGRES_HOST=localhost ``` + To use email service, set the follow variables in the config: + ``` 1 = true, 0 = false MAILER_HOST=mail.example.com diff --git a/lidarr/Readme.md b/lidarr/Readme.md index c99a2a00d..a3e56fca1 100644 --- a/lidarr/Readme.md +++ b/lidarr/Readme.md @@ -1,23 +1,28 @@ # Home assistant add-on: Lidarr + [![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 ![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 + +--- -# About ----------- [Lidarr](https://lidarr.audio/) is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new albums from your favorite artists 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. This addon is based on the docker image https://github.com/linuxserver/docker-lidarr -# Installation ----------- +## 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. 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 @@ -25,10 +30,12 @@ The installation of this add-on is pretty straightforward and not different in c 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. +## Configuration + +--- + +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 +49,14 @@ cifspassword: "password" # optional, smb password ``` ## Support + Create an issue on github -# Illustration --------------- -![illustration](https://www.geekzone.fr/wp-content/uploads/2018/05/lidarr_1.png) +## Illustration + +--- + +![illustration](https://www.geekzone.fr/wp-content/uploads/2018/05/lidarr_1.png) [repository]: https://github.com/alexbelgium/hassio-addons [smb-shield]: https://img.shields.io/badge/smb-yes-green.svg @@ -54,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/mealie/README.md b/mealie/README.md index 619954a59..d34c8fb77 100644 --- a/mealie/README.md +++ b/mealie/README.md @@ -1,4 +1,5 @@ # Hass.io Add-ons: Mealie + [![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 @@ Warning : armv7 only supported up to version 0.4.3! It won't be updated with later versions ## About + Mealie is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family. This addon is based on the [docker image](https://hub.docker.com/r/hkotel/mealie) from hay-kot. @@ -28,7 +30,7 @@ comparison to installing any other Hass.io add-on. - Start the addon. Wait a while and check the log for any errors. - Open yourdomain.com:9925 (where ":9925" is the port configured in the addon). -- Default +- Default - Username: changeme@email.com - Password: MyPassword diff --git a/nextcloud/README.md b/nextcloud/README.md index 6c118ac40..455c14f24 100644 --- a/nextcloud/README.md +++ b/nextcloud/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Nextcloud with OCR + [![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,7 +9,7 @@ ## About -Various tweaks and configuration options addition. +Various tweaks and configuration options addition. Inital fork from version : https://github.com/haberda/hassio_addons This addon is based on the [docker image](https://github.com/linuxserver/docker-nextcloud) from linuxserver.io. @@ -24,13 +25,12 @@ 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 ``` PGID/PUID : 1000 #allows setting user. -trusted_domains : your-domain.com #allows to select the trusted domains. Domains not in this lis will be removed, except for the first one used in the initial configuration. -OCR : false #set to true to install tesseract-ocr capability. +trusted_domains : your-domain.com #allows to select the trusted domains. Domains not in this lis will be removed, except for the first one used in the initial configuration. +OCR : false #set to true to install tesseract-ocr capability. OCRLANG : fra #Any language can be set from this page (always three letters) [here](https://tesseract-ocr.github.io/tessdoc/Data-Files#data-files-for-version-400-november-29-2016). use_own_certs : true/false #if true, use the certfile and keyfile specified certfile: fullchain.pem #ssl certificate, must be located in /ssl diff --git a/organizr/README.md b/organizr/README.md index da59fcd43..c986043a7 100644 --- a/organizr/README.md +++ b/organizr/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Organizr + [![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 @@ -24,6 +25,7 @@ comparison to installing any other Hass.io add-on. 1. Carefully configure the add-on to your preferences, see the official documentation for for that. ## Configuration + Webui can be found at . Create the db in /data/... @@ -33,9 +35,11 @@ GPID: user, can't be 0 ``` ## Support + Create an issue on github ## Illustration + ![bjaSt3fTfdXhw5vyl-7Lqz1EOjJIyh8lrdqxA53qO6E](https://user-images.githubusercontent.com/44178713/123061812-43601b00-d40c-11eb-993c-2aed31072775.jpg) [repository]: https://github.com/alexbelgium/hassio-addons diff --git a/papermerge/README.md b/papermerge/README.md index 88a1ccb42..e0e931cb0 100644 --- a/papermerge/README.md +++ b/papermerge/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Papermerge + [![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 diff --git a/photoprism/README.md b/photoprism/README.md index 2314ae4ec..f6da9ec32 100644 --- a/photoprism/README.md +++ b/photoprism/README.md @@ -39,11 +39,11 @@ Webui can be found at "cifsusername": "username" # optional, smb username, same for all smb shares "cifspassword": "password" # optional, smb password "cifsdomain": "domain" # optional, allow setting the domain for the smb share -"UPLOAD_NSFW": "true" allow uploads that may be offensive -"STORAGE_PATH": "/share/photoprism/storage" # storage PATH for cache, database and sidecar files -"ORIGINALS_PATH": "/share/photoprism/originals" # originals PATH containing your photo and video collection +"UPLOAD_NSFW": "true" allow uploads that may be offensive +"STORAGE_PATH": "/share/photoprism/storage" # storage PATH for cache, database and sidecar files +"ORIGINALS_PATH": "/share/photoprism/originals" # originals PATH containing your photo and video collection "IMPORT_PATH": "/share/photoprism/import" # PATH for importing files to originals -"BACKUP_PATH": "/share/photoprism/backup" # backup storage PATH +"BACKUP_PATH": "/share/photoprism/backup" # backup storage PATH "CUSTOM_OPTIONS": "--site-title HA_Photoprism" # custom options from https://docs.photoprism.org/getting-started/config-options/ ``` diff --git a/portainer/README.md b/portainer/README.md index d156471c8..07ba02bdb 100644 --- a/portainer/README.md +++ b/portainer/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Portainer + [![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 @@ -10,8 +11,10 @@ Forked from : https://github.com/hassio-addons/addon-portainer Implemented changes : update to latest versions ; ingress ; ssl ; password setting through addon option ; allow manual override -# About ----------- +## About + +--- + Portainer is an open-source lightweight management UI which allows you to easily manage your a Docker host(s) or Docker swarm clusters. @@ -30,12 +33,14 @@ your whole system. While this add-on is created and maintained with care and with security in mind, in the wrong or inexperienced hands, it could damage your system. -# Installation ----------- +## 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. 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 @@ -43,10 +48,12 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI and adapt the software options -# Configuration --------------- +## Configuration + +--- + Webui can be found at , or in your sidebar using Ingress. -The default username/password : described in the startup log. +The default username/password : described in the startup log. Configurations can be done through the app webUI, except for the following options ```yaml @@ -57,11 +64,14 @@ password: define admin password. If kept blank, will allow manual restore of pre ``` ## Support + Create an issue on github -# Illustration --------------- -![illustration](https://github.com/hassio-addons/addon-portainer/raw/main/images/screenshot.png) +## Illustration + +--- + +![illustration](https://github.com/hassio-addons/addon-portainer/raw/main/images/screenshot.png) [repository]: https://github.com/alexbelgium/hassio-addons [smb-shield]: https://img.shields.io/badge/smb-yes-green.svg diff --git a/prowlarr/README.md b/prowlarr/README.md index 4db22cb31..79859c143 100644 --- a/prowlarr/README.md +++ b/prowlarr/README.md @@ -1,24 +1,28 @@ - # Home assistant add-on: Prowlarr + [![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 ![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 ----------- -[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. +## 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 ----------- +## 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. 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 @@ -26,10 +30,12 @@ The installation of this add-on is pretty straightforward and not different in c 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. +## Configuration + +--- + +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 @@ -43,10 +49,13 @@ cifspassword: "password" # optional, smb password ``` ## Support + Create an issue on github -# Illustration --------------- +## Illustration + +--- + ![illustration](https://wiki.servarr.com/assets/prowlarr/hist_1_history.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/qbittorrent/README.md b/qbittorrent/README.md index 225d38aae..829230964 100644 --- a/qbittorrent/README.md +++ b/qbittorrent/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: qbittorrent + [![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 @@ -7,12 +8,15 @@ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports smb mounts][smb-shield] ![Supports openvpn][openvpn-shield] ![Supports ingress][ingress-shield] ![Supports ssl][ssl-shield] -# About ----------- +## About + +--- + [Qbittorrent](https://github.com/qbittorrent/qBittorrent) is a cross-platform free and open-source BitTorrent client. This addon is based on the docker image from [linuxserver.io](https://www.linuxserver.io/). This addons has several configurable options : + - allowing to mount local external drive, or smb share from the addon - [alternative webUI](https://github.com/qbittorrent/qBittorrent/wiki/List-of-known-alternate-WebUIs) - usage of ssl @@ -20,12 +24,14 @@ This addons has several configurable options : - optional openvpn support - allow setting specific DNS servers -# Installation ----------- +## 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. 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 @@ -33,10 +39,12 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI and adapt the software options -# Configuration --------------- +## Configuration + +--- + Webui can be found at , or in your sidebar using Ingress. -The default username/password : described in the startup log. +The default username/password : described in the startup log. Configurations can be done through the app webUI, except for the following options Network disk is mounted to /mnt/share name @@ -48,7 +56,7 @@ ssl: true/false certfile: fullchain.pem #ssl certificate, must be located in /ssl keyfile: privkey.pem #sslkeyfile, must be located in /ssl whitelist: "localhost,192.168.0.0/16" # list ip subnets that won't need a password (optional) -Username: "admin" #username to access webui. Please change it as the default is admin for all installations. +Username: "admin" #username to access webui. Please change it as the default is admin for all installations. customUI: selection from list # alternative webUI can be set here. Latest version set at each addon start. DNS_servers : 8.8.8.8,1.1.1.1 # Keep blank to use router’s DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover SavePath: "/share/qbittorrent" # Define the download directory @@ -59,21 +67,26 @@ cifspassword: "password" # optional, smb password cifsdomain: "domain" # optional, allow setting the domain for the smb share password, same for all smb shares openvpn_enabled: true/false # is openvpn required to start qbittorrent -openvpn_alternative_mode: true/false # if enabled, will tunnel only qbittorrent and not webui through vpn. Allows webui connection from external networks, but risk of decreased stability. -openvpn_config": For example "config.ovpn" # name of the file located in /config/openvpn. +openvpn_alternative_mode: true/false # if enabled, will tunnel only qbittorrent and not webui through vpn. Allows webui connection from external networks, but risk of decreased stability. +openvpn_config": For example "config.ovpn" # name of the file located in /config/openvpn. openvpn_username": USERNAME openvpn_password: YOURPASSWORD run_duration: 12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) ``` -# Integration with HA + +## Integration with HA + Use the [qBittorrent integration](https://www.home-assistant.io/integrations/qbittorrent/) ## Support + Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-qbittorrent/279247) -# Illustration (vuetorrent webui) --------------- -![illustration](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/qbittorrent/illustration.png) +## Illustration (vuetorrent webui) + +--- + +![illustration](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/qbittorrent/illustration.png) [repository]: https://github.com/alexbelgium/hassio-addons [smb-shield]: https://img.shields.io/badge/smb-yes-green.svg @@ -84,4 +97,3 @@ Create an issue on github, or ask on the [home assistant thread](https://communi [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/radarr/README.md b/radarr/README.md index bde960892..4eae5ffc5 100644 --- a/radarr/README.md +++ b/radarr/README.md @@ -1,23 +1,28 @@ # Home assistant add-on: Radarr + [![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 ![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 + +--- -# About ----------- [Radarr](https://radarr.video/) Radarr is a 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. This addon is based on the docker image https://github.com/linuxserver/docker-radarr -# Installation ----------- +## 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. 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 @@ -25,10 +30,12 @@ The installation of this add-on is pretty straightforward and not different in c 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. +## Configuration + +--- + +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,10 +49,13 @@ cifspassword: "password" # optional, smb password ``` ## Support + Create an issue on github -# Illustration --------------- +## Illustration + +--- + ![illustration](https://dausruddin.com/wp-content/uploads/2020/05/radarr-v3-1024x515.png) [repository]: https://github.com/alexbelgium/hassio-addons @@ -54,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/readarr/Readme.md b/readarr/Readme.md index b82b99d8d..5c790daab 100644 --- a/readarr/Readme.md +++ b/readarr/Readme.md @@ -8,14 +8,15 @@ 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 --- [Readarr](https://github.com/Readarr/Readarr) is a ebook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will interface with clients and indexers to grab, sort, and rename them.is book Manager and Automation (Sonarr for Ebooks). This addon is based on the docker image https://github.com/linuxserver/docker-readarr -# Installation +## Installation + --- The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. @@ -29,7 +30,7 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI and adapt the software options -# Configuration +## Configuration --- @@ -51,13 +52,12 @@ cifspassword: "password" # optional, smb password Create an issue on github -# Illustration +## Illustration --- ![illustration](https://readarr.com/img/slider/artistdetails.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 diff --git a/requestrr/Readme.md b/requestrr/Readme.md index 80ff7f651..3ac1fa272 100644 --- a/requestrr/Readme.md +++ b/requestrr/Readme.md @@ -8,14 +8,14 @@ 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 --- [Requestrr](https://github.com/darkalfx/requestrr) is a chatbot used to simplify using services like Sonarr/Radarr/Ombi via the use of chat. Current platform is Discord only, but the bot was built around the ideology of quick adaptation for new features as well as new platforms. This addon is based on the docker image https://github.com/linuxserver/docker-requestrr -# Installation +## Installation --- @@ -30,7 +30,7 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI and adapt the software options -# Configuration +## Configuration --- @@ -48,7 +48,7 @@ TZ: timezone Create an issue on github -# Illustration +## Illustration ![illustration](https://nashosted.com/wp-content/uploads/2020/04/requestrr-discord-nashosted.com_-1024x680.jpg) diff --git a/resiliosync/README.md b/resiliosync/README.md index ec52e6bc0..03ad70002 100644 --- a/resiliosync/README.md +++ b/resiliosync/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Resilio Sync + [![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 @@ -25,6 +26,7 @@ comparison to installing any other Hass.io add-on. 1. Carefully configure the add-on to your preferences, see the official documentation for for that. ## Configuration + Webui can be found at . ```yaml @@ -33,6 +35,7 @@ GPID: user ``` ## Support + Create an issue on github [repository]: https://github.com/alexbelgium/hassio-addons diff --git a/scrutiny/README.md b/scrutiny/README.md index fb05703d9..e604243b7 100644 --- a/scrutiny/README.md +++ b/scrutiny/README.md @@ -9,20 +9,24 @@ Hi, I've create an addon for my use and wanted to share it if it can be useful to other people ;-) +## About + +--- -# About ----------- [Scrutiny](https://github.com/AnalogJ/scrutiny) is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates. This addon is based on the [docker image](https://hub.docker.com/r/linuxserver/scrutiny) from [linuxserver.io](https://www.linuxserver.io/). Features : + - SMART monitoring - Automatic addition of local drives - Hourly updates - Ingress with/without ssl - Automatic upstream updates -# Installation ----------- +## Installation + +--- + The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. 1. [Add my Hass.io add-ons repository][repository] to your home assistant instance. @@ -33,9 +37,11 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI (Ingress based) and adapt the software options -# Configuration --------------- -Webui can be found at , or through Ingress. +## Configuration + +--- + +Webui can be found at , or through Ingress. It automatically mounts all local drives. ```yaml @@ -47,18 +53,21 @@ keyfile: privkey.pem #sslkeyfile ``` # Integration in home assistant --------------- -Integration with HA can be done with the [rest platform](https://www.home-assistant.io/integrations/rest) in configuration.yaml. + +--- + +Integration with HA can be done with the [rest platform](https://www.home-assistant.io/integrations/rest) in configuration.yaml. Two types of api endpoints are available: + - Summary data : http://YOURIP:ADDONPORT/api/summary - Detailed data : http://YOURIP:ADDONPORT/api/WWN/details For the detailed data, wmn can be found for each hdd within the scrutiny app. For example for me : http://192.168.178.23:8086/api/device/0x50014ee606c14537/details -Example to get data from the first hdd. +Example to get data from the first hdd. -```yaml +```yaml rest: - verify_ssl: false scan_interval: 60 @@ -79,11 +88,14 @@ rest: - "scsi_attributes" ``` -# Illustration --------------- +## Illustration + +--- + ![](https://github.com/AnalogJ/scrutiny/raw/master/docs/dashboard.png) ## Support + Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-scrutiny-smart-dashboard/295747) https://github.com/alexbelgium/hassio-addons diff --git a/sonarr/README.md b/sonarr/README.md index a5b7f5183..bcdb7051b 100644 --- a/sonarr/README.md +++ b/sonarr/README.md @@ -6,28 +6,38 @@ ![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 + +--- -# About ----------- [Sonarr](https://sonarr.tv/) is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. This addon is based on the docker image https://github.com/linuxserver/docker-sonarr -# Installation ----------- + +## 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. 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. + +## Configuration + +--- + +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 GUID: user GPID: user @@ -37,10 +47,15 @@ networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separat cifsusername: "username" # optional, smb username, same for all smb shares cifspassword: "password" # optional, smb password ``` + ## Support + Create an issue on github -# Illustration --------------- + +## Illustration + +--- + ![illustration](https://b0b.fr/wp-content/uploads/2016/02/Sonarr-1-1000x924.jpg) [repository]: https://github.com/alexbelgium/hassio-addons diff --git a/teamspeak/README.md b/teamspeak/README.md index a1809ce57..d49f858ab 100644 --- a/teamspeak/README.md +++ b/teamspeak/README.md @@ -1,4 +1,5 @@ # Hass.io Add-ons: Teamspeak + [![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 @@ -7,6 +8,7 @@ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ## About + TeamSpeak offers the ideal voice communication for online gaming, education and training, internal business communication, and staying in touch with friends and family. Our primary focus is delivering a solution that is easy to use, with high security standards, excellent voice quality, and low system and bandwidth usage. Based on https://hub.docker.com/r/ertagh/teamspeak3-server (arm) and https://hub.docker.com/r/mbentley/teamspeak:latest (x64) diff --git a/transmission/README.md b/transmission/README.md index 92aac4de1..df98793d9 100644 --- a/transmission/README.md +++ b/transmission/README.md @@ -1,4 +1,5 @@ # Home assistant add-on: Transmission + [![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 @@ -25,13 +26,14 @@ comparison to installing any other Hass.io add-on. ## Configuration -Options : -- "download_dir": "/share/downloads" # where the files will be saved after download -- "incomplete_dir": "/share/incomplete" # where the files are saved during download -- "localdisks": ["sda1"] # list of devices to mount, '' if none -- "networkdisks": "" # list of smbv2/3 servers to mount, '' if none -- "cifsusername": "" # smb username -- "cifspassword": "" # smb password +Options : + +- "download_dir": "/share/downloads" # where the files will be saved after download +- "incomplete_dir": "/share/incomplete" # where the files are saved during download +- "localdisks": ["sda1"] # list of devices to mount, '' if none +- "networkdisks": "" # list of smbv2/3 servers to mount, '' if none +- "cifsusername": "" # smb username +- "cifspassword": "" # smb password Complete transmission options are in /share/transmission (make sure addon is stopped before modifying it as Transmission writes its ongoing values when stopping and could erase your changes) diff --git a/ubooquity/README.md b/ubooquity/README.md index 0886d6d72..d0582b947 100644 --- a/ubooquity/README.md +++ b/ubooquity/README.md @@ -8,12 +8,15 @@ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ## About ----------- + +--- + [Ubooquity by vaemendis](https://vaemendis.net/ubooquity/) is a free, lightweight and easy-to-use home server for your comics and ebooks developed . This addon is based on the [docker image](https://github.com/linuxserver/docker-ubooquity) from [linuxserver.io](https://www.linuxserver.io/). Ubooquity supports many types of files, with a preference for ePUB, CBZ, CBR and PDF files. Metadata from library management software Calibre and ComicRack are also supported. Ubooquity lets you create user accounts and set access rights for each shared folder. This addons has several configurable options : + - allowing to mount local external drive, or smb share from the addon (decreases performance) - **VERY IMPORTANT, CAN CRASH SYSTEM** : Setting of the maximum RAM usage for java. The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations and you'll get "java.lang.OutOfMemoryError: Java heap space errors". If the quantity allocated is too high for your system, it will crash home assistant and you'll need to manually reboot. Value is a number of megabytes ( put just a number, without MB). @@ -31,11 +34,13 @@ comparison to installing any other Hass.io add-on. 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI, set an admin password and adapt the administration options -# Configuration --------------- +## Configuration + +--- + Admin webui can be found at . Library webui can be found at . You can also access it by clicking on the ubooquity logo at top left of the admin page, or use a mobile app (preferred option, see above for instructions) -The default username/password : described in the startup log. +The default username/password : described in the startup log. Configurations can be done through the app webUI, except for the following options Network disk is mounted to /mnt/share name @@ -43,7 +48,7 @@ Network disk is mounted to /mnt/share name ```yaml GUID: user GPID: user -maxmem: 200 # IMPORTANT read above. 200 is default for rpi3b+ ; 512 recommended if more 2gb RAM. +maxmem: 200 # IMPORTANT read above. 200 is default for rpi3b+ ; 512 recommended if more 2gb RAM. networkdisks: "" # list of smbv2/3 servers to mount (optional) cifsusername: "username" # smb username (optional) cifspassword: "password" # smb password (optional) @@ -51,10 +56,13 @@ smbv1: false # Should smbv1 be used instead of 2.1+? ``` ## Support + Create an issue on the [repository github][repository], or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-ubooquity/283811) -# Illustration --------------- +## Illustration + +--- + ![alt text](https://vaemendis.net/ubooquity/data/images/screenshots/books_library.jpg) [repository]: https://github.com/alexbelgium/hassio-addons diff --git a/webtrees/README.md b/webtrees/README.md index 137d1df02..41892e471 100644 --- a/webtrees/README.md +++ b/webtrees/README.md @@ -6,10 +6,12 @@ ![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 + +--- -# About ----------- [webtrees](http://www.webtrees.net) is the web's leading online collaborative genealogy application. It works from standard GEDCOM files, and is therefore compatible with every major desktop application. @@ -18,12 +20,14 @@ webtrees allows you to view and edit your genealogy on your website. It has full This addon is based on the docker image https://github.com/NathanVaughn/webtrees-docker -# Installation ----------- +## 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. 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 @@ -31,24 +35,29 @@ The installation of this add-on is pretty straightforward and not different in c 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 . +## Configuration + +--- + +Webui can be found at . The default username/password : described in the startup log. Please change it as soon as possible. Configurations can be done through the app webUI, except for the following options ```yaml - "LANG": "en-US" # Default language for webtrees - "BASE_URL": "http://192.168.178.69" # The url with which you access webtrees - "DB_TYPE": "sqlite" # Your database type : sqlite for automatic configuration, or external for manual config +"LANG": "en-US" # Default language for webtrees +"BASE_URL": "http://192.168.178.69" # The url with which you access webtrees +"DB_TYPE": "sqlite" # Your database type : sqlite for automatic configuration, or external for manual config ``` ## Support + Create an issue on github -# Illustration --------------- +## Illustration + +--- + ![illustration](https://installatron.infomaniak.com/installatron//images/ss2_webtrees.jpg) [repository]: https://github.com/alexbelgium/hassio-addons diff --git a/wger/README.md b/wger/README.md index e1e6a540e..4101156f7 100644 --- a/wger/README.md +++ b/wger/README.md @@ -1,4 +1,5 @@ # Hass.io Add-ons: Wger + [![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 @@ -7,6 +8,7 @@ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ## About + [wger](https://github.com/wger-project/wger) Workout Manager is a free, open source web application that helps you manage your personal workouts, weight and diet plans and can also be used as a simple gym management utility. It offers a REST API as well, for easy integration with other projects and tools. ## Installation @@ -25,11 +27,12 @@ comparison to installing any other Hass.io add-on. - Start the addon. Wait a while and check the log for any errors. - Open yourdomain.com:8000 (where ":8000" is the port configured in the addon). -- Default - - Username: ```admin``` - - Password: ```adminadmin``` +- Default + - Username: `admin` + - Password: `adminadmin` ```yaml + ``` ## Support