From 294dd7c52cd965b79b73502b201ba0d5868d3a9b Mon Sep 17 00:00:00 2001 From: Alexandre Date: Fri, 1 Aug 2025 22:30:45 +0200 Subject: [PATCH] Claudify --- booksonic_air/README.md | 56 ++++++++++++++++----- comixed/README.md | 94 +++++++++++++++++++++++++++++++++++- elasticsearch/README.md | 27 ++++++++++- enedisgateway2mqtt/README.md | 39 +++++++++++---- 4 files changed, 194 insertions(+), 22 deletions(-) diff --git a/booksonic_air/README.md b/booksonic_air/README.md index 2f7bb79d2..56ead8b6d 100644 --- a/booksonic_air/README.md +++ b/booksonic_air/README.md @@ -44,22 +44,56 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration ---- +Webui can be found at . +Default credentials are shown in the startup logs. -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 +### Setup Steps + +1. Access the web interface after starting the addon +2. Initial setup wizard will guide you through configuration +3. Add your audiobook directories via the web interface +4. Configure transcoding settings if needed + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `PGID` | int | `0` | Group ID for file permissions | +| `PUID` | int | `0` | User ID for file permissions | +| `TZ` | str | | Timezone (e.g., `Europe/London`) | +| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) | +| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) | +| `cifsusername` | str | | SMB username for network shares | +| `cifspassword` | str | | SMB password for network shares | +| `cifsdomain` | str | | SMB domain for network shares | + +### Example Configuration ```yaml -PGID: user -GPID: user -TZ: timezone -localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS... -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 +PGID: 1000 +PUID: 1000 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/audiobooks" +cifsusername: "audiobookuser" +cifspassword: "password123" +cifsdomain: "workgroup" ``` +### Mounting Drives + +This addon supports mounting both local drives and remote SMB shares: + +- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons) +- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons) + +### Custom Scripts and Environment Variables + +This addon supports custom script execution and environment variable injection: + +- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons) +- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon) + ## Support Create an issue on github diff --git a/comixed/README.md b/comixed/README.md index 4834fdb80..bfbb6f566 100644 --- a/comixed/README.md +++ b/comixed/README.md @@ -1 +1,93 @@ -# Home assistant add-on: Comixed \ No newline at end of file +# Home assistant add-on: Comixed + +[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) +[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA) + +![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fcomixed%2Fconfig.json) +![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fcomixed%2Fconfig.json) +![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fcomixed%2Fconfig.json) + +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) +[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) +[![Builder](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/onpush_builder.yaml?label=Builder)](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml) + +[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20(no%20paypal)-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white +[paypal-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20with%20Paypal-0070BA?logo=paypal&style=flat&logoColor=white + +_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_ + +[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) + +![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/comixed/stats.png) + +## About + +[ComiXed](https://github.com/comixed/comixed) is a cross-platform digital comic management application designed to handle large libraries of digital comics. + +Key features: +- Comic library management and organization +- Metadata scraping from Comic Vine +- Reading list creation and management +- Web-based reading interface +- Support for multiple comic formats (CBZ, CBR, CB7, PDF) +- User management and permissions + +## 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 . +Initial setup requires creating an admin account through the web interface. + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `TZ` | str | | Timezone (e.g., `Europe/London`) | +| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) | +| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) | +| `cifsusername` | str | | SMB username for network shares | +| `cifspassword` | str | | SMB password for network shares | +| `cifsdomain` | str | | SMB domain for network shares | + +### Example Configuration + +```yaml +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/comics" +cifsusername: "comicuser" +cifspassword: "password123" +cifsdomain: "workgroup" +``` + +### Mounting Drives + +This addon supports mounting both local drives and remote SMB shares: + +- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons) +- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons) + +### Custom Scripts and Environment Variables + +This addon supports custom script execution and environment variable injection: + +- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons) +- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon) + +## Support + +Create an issue on github + +[repository]: https://github.com/alexbelgium/hassio-addons \ No newline at end of file diff --git a/elasticsearch/README.md b/elasticsearch/README.md index 1e5d29091..3830c91ff 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -54,7 +54,32 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration -Elasticsearch is using by calling it from another app, such as nextcloud. +Elasticsearch runs as a single-node cluster accessible at . +This addon has no web interface - it provides API endpoints for other applications. + +### API Endpoints + +- **HTTP API**: Port 9200 for REST API calls +- **Transport**: Port 9300 for internal cluster communication + +### Options + +No configuration options are available through the addon interface. Elasticsearch is pre-configured for single-node operation with: +- Memory allocation: 1GB heap (ES_JAVA_OPTS) +- Discovery type: single-node +- Memory lock: enabled +- Tini subreaper: enabled + +### Example Usage + +Connect other applications to Elasticsearch using: +- URL: `http://homeassistant:9200` +- No authentication required (local network only) + +### Integration Examples + +- **Nextcloud**: Configure Full Text Search app to use this Elasticsearch instance +- **Home Assistant**: Use with the Elasticsearch component for event publishing ## Integration with HA diff --git a/enedisgateway2mqtt/README.md b/enedisgateway2mqtt/README.md index c76913b42..ddafd0e89 100644 --- a/enedisgateway2mqtt/README.md +++ b/enedisgateway2mqtt/README.md @@ -26,22 +26,43 @@ MyElectricalData allows an automated access to your Enedis data. See its github ## Configuration -Install, then start the addon a first time to initialize the templates. +Webui can be found at or through Ingress. +Initial setup requires starting the addon once to initialize configuration templates. -Options can be configured through two ways : +### Setup Steps -- Addon options +1. Start the addon to initialize configuration files +2. Configure your Enedis credentials in the config.yaml file +3. Set up MQTT connection details +4. Access the web interface to monitor data retrieval + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `CONFIG_LOCATION` | str | `/config/myelectricaldata/config.yaml` | Path to configuration file | +| `TZ` | str | `Europe/Paris` | Timezone (e.g., `Europe/London`) | +| `mqtt_autodiscover` | bool | `true` | Enable MQTT autodiscovery | +| `verbose` | bool | `true` | Enable verbose logging | + +### Example Configuration ```yaml -CONFIG_LOCATION: /config/myelectricaldata/config.yaml # Sets the location of the config.yaml (see below) -mqtt_autodiscover: true # Shows in the log the detail of the mqtt local server (if available). It can then be added to the config.yaml file. -TZ: Europe/Paris # Sets a specific timezone +CONFIG_LOCATION: "/config/myelectricaldata/config.yaml" +TZ: "Europe/London" +mqtt_autodiscover: true +verbose: false ``` -- Config.yaml - Everything is configured using the config.yaml file found in /config/myelectricaldata/config.yaml. +### Configuration File -The complete list of options can be seen here : https://github.com/m4dm4rtig4n/myelectricaldata/wiki/03.-Configuration +The main configuration is done via `/config/myelectricaldata/config.yaml`. This file contains: +- Enedis API credentials +- MQTT broker settings +- Data retrieval intervals +- Device configurations + +For complete configuration options, see: https://github.com/m4dm4rtig4n/myelectricaldata/wiki/03.-Configuration ## Installation