mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
Claudify
This commit is contained in:
@@ -2,27 +2,7 @@
|
||||
"$schema": "https://json.schemastore.org/claude-code-settings.json",
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"Bash(*)",
|
||||
"Bash(cp:*)",
|
||||
"Bash(find:*)",
|
||||
"Bash(ls:*)",
|
||||
"Bash(for:*)",
|
||||
"Bash(do echo \"=== Checking $dir ===\")",
|
||||
"Bash(if [ -f \"$dir/README.md\" ])",
|
||||
"Bash(then echo \"README.md exists\")",
|
||||
"Bash(wc:*)",
|
||||
"Bash(head:*)",
|
||||
"Bash(else echo \"README.md MISSING\")",
|
||||
"Bash(fi)",
|
||||
"Bash(echo)",
|
||||
"Bash(done)",
|
||||
"Bash(do if [ ! -f \"$dir/README.md\" ])",
|
||||
"Bash(then echo \"MISSING README: $dir\")",
|
||||
"Bash(do if [ -f \"$dir/README.md\" ])",
|
||||
"Bash(then if ! grep -q \"## About\" \"$dir/README.md\")",
|
||||
"Bash(! grep -q \"## Installation\" \"$dir/README.md\")",
|
||||
"Bash(! grep -q \"## Configuration\" \"$dir/README.md\")",
|
||||
"Bash(then echo \"⚠️ MINIMAL STRUCTURE: $dir (missing About, Installation, AND Configuration sections)\")"
|
||||
"Bash"
|
||||
],
|
||||
"deny": []
|
||||
}
|
||||
|
||||
@@ -18,7 +18,7 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||

|
||||
|
||||
## About
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
|
||||
@@ -1,3 +1,83 @@
|
||||
# Home assistant add-on: Immich Power Tools
|
||||
# Home assistant add-on: Immich Frame
|
||||
|
||||
https://immichframe.online/
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
[](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!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||
|
||||
## About
|
||||
|
||||
[Immich Frame](https://immichframe.online/) displays your Immich gallery as a digital photo frame. Transform any screen into a beautiful, rotating display of your personal photos and memories stored in Immich.
|
||||
|
||||
This addon allows you to create a digital photo frame that connects to your Immich server and displays your photos in a slideshow format, perfect for repurposing old tablets or monitors as dedicated photo displays.
|
||||
|
||||
## Configuration
|
||||
|
||||
Webui can be found at `<your-ip>:8171`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `ImmichServerUrl` | str | **Required** | URL of your Immich server (e.g., `http://homeassistant:3001`) |
|
||||
| `ApiKey` | str | **Required** | Immich API key for authentication |
|
||||
| `TZ` | str | | Timezone (e.g., `Europe/London`) |
|
||||
|
||||
### Example Configuration
|
||||
|
||||
```yaml
|
||||
ImmichServerUrl: "http://homeassistant:3001"
|
||||
ApiKey: "your-immich-api-key-here"
|
||||
TZ: "Europe/London"
|
||||
```
|
||||
|
||||
### Getting Your Immich API Key
|
||||
|
||||
1. Open your Immich web interface
|
||||
2. Go to **Administration** > **API Keys**
|
||||
3. Click **Create API Key**
|
||||
4. Give it a descriptive name (e.g., "Photo Frame")
|
||||
5. Copy the generated API key and paste it in the addon configuration
|
||||
|
||||
### Custom Scripts and Environment Variables
|
||||
|
||||
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
||||
|
||||
- **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)
|
||||
|
||||
## 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. Configure your Immich server URL and API key.
|
||||
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.
|
||||
1. Open the webUI to configure your photo frame settings.
|
||||
|
||||
## Support
|
||||
|
||||
Create an issue on github, or ask on the [home assistant community forum](https://community.home-assistant.io/)
|
||||
|
||||
For more information about Immich Frame, visit: https://immichframe.online/
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
@@ -1,3 +1,123 @@
|
||||
# Home assistant add-on: Immich Power Tools
|
||||
|
||||
https://github.com/varun-raj/immich-power-tools
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
[](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!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||
|
||||
## About
|
||||
|
||||
[Immich Power Tools](https://github.com/varun-raj/immich-power-tools) provides advanced tools for organizing and managing your Immich photo library. This addon extends Immich's capabilities with powerful features for photo organization, analysis, and management.
|
||||
|
||||
Key features:
|
||||
- Advanced photo organization tools
|
||||
- Batch operations for photo management
|
||||
- AI-powered photo analysis and tagging
|
||||
- Geographic photo mapping with Google Maps integration
|
||||
- Duplicate detection and management
|
||||
- Advanced search and filtering capabilities
|
||||
|
||||
This addon is based on the [immich-power-tools](https://github.com/varun-raj/immich-power-tools) project.
|
||||
|
||||
## Configuration
|
||||
|
||||
Webui can be found at `<your-ip>:8001`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `IMMICH_URL` | str | **Required** | Internal Immich server URL (e.g., `http://homeassistant:3001`) |
|
||||
| `EXTERNAL_IMMICH_URL` | str | **Required** | External Immich server URL for browser access |
|
||||
| `IMMICH_API_KEY` | str | **Required** | Immich API key for authentication |
|
||||
| `DB_HOST` | str | **Required** | Database hostname (e.g., `core-mariadb` or `homeassistant`) |
|
||||
| `DB_USERNAME` | str | **Required** | Database username |
|
||||
| `DB_PASSWORD` | str | **Required** | Database password |
|
||||
| `DB_DATABASE_NAME` | str | **Required** | Database name (usually `immich`) |
|
||||
| `DB_PORT` | str | **Required** | Database port (usually `5432` for PostgreSQL) |
|
||||
| `GOOGLE_MAPS_API_KEY` | str | | Google Maps API key for geographic features |
|
||||
| `GEMINI_API_KEY` | str | | Google Gemini API key for AI features |
|
||||
|
||||
### Example Configuration
|
||||
|
||||
```yaml
|
||||
IMMICH_URL: "http://homeassistant:3001"
|
||||
EXTERNAL_IMMICH_URL: "https://your-immich-domain.com"
|
||||
IMMICH_API_KEY: "your-immich-api-key-here"
|
||||
DB_HOST: "core-mariadb"
|
||||
DB_USERNAME: "immich"
|
||||
DB_PASSWORD: "your-db-password"
|
||||
DB_DATABASE_NAME: "immich"
|
||||
DB_PORT: "5432"
|
||||
GOOGLE_MAPS_API_KEY: "your-google-maps-api-key"
|
||||
GEMINI_API_KEY: "your-gemini-api-key"
|
||||
```
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before using this addon, ensure you have:
|
||||
|
||||
1. **Immich server running** - This addon requires a working Immich installation
|
||||
2. **Database access** - You need direct access to your Immich database
|
||||
3. **Immich API key** - Generate an API key from your Immich admin panel
|
||||
|
||||
### Getting API Keys
|
||||
|
||||
**Immich API Key:**
|
||||
1. Open your Immich web interface
|
||||
2. Go to **Administration** > **API Keys**
|
||||
3. Click **Create API Key**
|
||||
4. Copy the generated key
|
||||
|
||||
**Google Maps API Key** (optional):
|
||||
1. Visit the [Google Cloud Console](https://console.cloud.google.com/)
|
||||
2. Create a new project or select an existing one
|
||||
3. Enable the Maps JavaScript API
|
||||
4. Create credentials (API key)
|
||||
|
||||
**Google Gemini API Key** (optional):
|
||||
1. Visit [Google AI Studio](https://makersuite.google.com/app/apikey)
|
||||
2. Create a new API key for Gemini
|
||||
|
||||
### Custom Scripts and Environment Variables
|
||||
|
||||
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
||||
|
||||
- **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)
|
||||
|
||||
## 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. Configure all required database and API settings.
|
||||
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.
|
||||
1. Open the webUI to start using the power tools.
|
||||
|
||||
## Support
|
||||
|
||||
Create an issue on github, or ask on the [home assistant community forum](https://community.home-assistant.io/)
|
||||
|
||||
For more information about Immich Power Tools, visit: https://github.com/varun-raj/immich-power-tools
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
139
monica/README.md
139
monica/README.md
@@ -1 +1,138 @@
|
||||
# Home assistant add-on: monica
|
||||
# Home assistant add-on: Monica
|
||||
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
[](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!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||
|
||||
## About
|
||||
|
||||
[Monica](https://www.monicahq.com/) is a Personal Relationship Manager (PRM) that helps you organize your social life and keep track of your relationships with friends, family, and colleagues. It's like a CRM, but for your personal life.
|
||||
|
||||
Key features:
|
||||
- Track conversations, activities, and important dates
|
||||
- Store contact information and relationship details
|
||||
- Set reminders for birthdays, anniversaries, and follow-ups
|
||||
- Document gifts given and received
|
||||
- Track debts and favors
|
||||
- Organize notes and memories about people
|
||||
- Journal functionality
|
||||
- Gift ideas tracking
|
||||
- Multiple database options (SQLite, MariaDB, MySQL)
|
||||
|
||||
This addon is based on the official [Monica](https://github.com/monicahq/monica) application.
|
||||
|
||||
## Configuration
|
||||
|
||||
Webui can be found at `<your-ip>:8181`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `database` | list | `sqlite` | Database type (sqlite/MariaDB_addon/Mysql_external) |
|
||||
| `APP_KEY` | str | | Application encryption key (auto-generated if empty) |
|
||||
| `DB_DATABASE` | str | | Database name (for external MySQL/MariaDB) |
|
||||
| `DB_HOST` | str | | Database hostname (for external MySQL/MariaDB) |
|
||||
| `DB_USERNAME` | str | | Database username (for external MySQL/MariaDB) |
|
||||
| `DB_PASSWORD` | str | | Database password (for external MySQL/MariaDB) |
|
||||
| `DB_PORT` | int | | Database port (for external MySQL/MariaDB) |
|
||||
| `MAIL_MAILER` | str | `log` | Mail driver (smtp/log/sendmail) |
|
||||
| `MAIL_HOST` | str | | SMTP server hostname |
|
||||
| `MAIL_PORT` | str | | SMTP server port |
|
||||
| `MAIL_USERNAME` | str | | SMTP username |
|
||||
| `MAIL_PASSWORD` | str | | SMTP password |
|
||||
| `MAIL_ENCRYPTION` | str | | SMTP encryption (tls/ssl) |
|
||||
| `MAIL_FROM_ADDRESS` | str | | From email address |
|
||||
| `MAIL_FROM_NAME` | str | | From email name |
|
||||
|
||||
### Example Configuration
|
||||
|
||||
```yaml
|
||||
database: "sqlite"
|
||||
APP_KEY: "" # Will be auto-generated
|
||||
MAIL_MAILER: "smtp"
|
||||
MAIL_HOST: "smtp.gmail.com"
|
||||
MAIL_PORT: "587"
|
||||
MAIL_USERNAME: "your-email@gmail.com"
|
||||
MAIL_PASSWORD: "your-app-password"
|
||||
MAIL_ENCRYPTION: "tls"
|
||||
MAIL_FROM_ADDRESS: "your-email@gmail.com"
|
||||
MAIL_FROM_NAME: "Monica"
|
||||
```
|
||||
|
||||
### Database Configuration
|
||||
|
||||
**SQLite (Default):**
|
||||
- No additional configuration required
|
||||
- Data stored in addon directory
|
||||
- Suitable for single-user setups
|
||||
|
||||
**MariaDB Addon:**
|
||||
- Set `database` to `MariaDB_addon`
|
||||
- Requires MariaDB addon to be installed and running
|
||||
- Addon will auto-configure database connection
|
||||
|
||||
**External MySQL/MariaDB:**
|
||||
- Set `database` to `Mysql_external`
|
||||
- Configure all `DB_*` options with your database details
|
||||
|
||||
### Email Configuration
|
||||
|
||||
Configure SMTP settings to enable:
|
||||
- Password reset emails
|
||||
- Invitation emails
|
||||
- Notification emails
|
||||
- Reminder emails
|
||||
|
||||
### Custom Scripts and Environment Variables
|
||||
|
||||
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
||||
|
||||
- **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)
|
||||
|
||||
## 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. Configure database and email settings as needed.
|
||||
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.
|
||||
1. Open the webUI to set up your Monica account.
|
||||
|
||||
## First Setup
|
||||
|
||||
After installation and startup:
|
||||
|
||||
1. Open the webUI at `<your-ip>:8181`
|
||||
2. Create your first user account
|
||||
3. Complete the setup wizard
|
||||
4. Start adding your contacts and relationships
|
||||
|
||||
## Support
|
||||
|
||||
Create an issue on github, or ask on the [home assistant community forum](https://community.home-assistant.io/)
|
||||
|
||||
For more information about Monica, visit: https://www.monicahq.com/
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
|
||||
92
netalertx_fa/README.md
Normal file
92
netalertx_fa/README.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# Home assistant add-on: NetAlertX Full Access
|
||||
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
[](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!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||
|
||||
## About
|
||||
|
||||
[NetAlertX](https://github.com/jokob-sk/NetAlertX) is a WIFI / LAN scanner, intruder, and presence detector that helps you monitor your network for new devices and potential security threats.
|
||||
|
||||
**This is the Full Access version** that provides additional privileges and network access capabilities compared to the standard NetAlertX addon.
|
||||
|
||||
Key features:
|
||||
- Network device discovery and monitoring
|
||||
- Presence detection for known devices
|
||||
- Intrusion detection for unknown devices
|
||||
- Web-based dashboard for network visualization
|
||||
- MQTT integration for Home Assistant
|
||||
- Network scanning with enhanced privileges
|
||||
|
||||
## Configuration
|
||||
|
||||
Webui can be found at `<your-ip>:20211` or through the sidebar using Ingress.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `TZ` | str | `Europe/Berlin` | Timezone (e.g., `Europe/London`) |
|
||||
| `APP_CONF_OVERRIDE` | str | | Additional app configuration overrides |
|
||||
|
||||
### Example Configuration
|
||||
|
||||
```yaml
|
||||
TZ: "Europe/London"
|
||||
APP_CONF_OVERRIDE: "SCAN_SUBNETS=['192.168.1.0/24']"
|
||||
```
|
||||
|
||||
### MQTT Integration
|
||||
|
||||
This addon supports MQTT integration and will automatically connect to your Home Assistant MQTT broker if available. NetAlertX can publish device presence information to MQTT topics for integration with Home Assistant automations.
|
||||
|
||||
### Custom Scripts and Environment Variables
|
||||
|
||||
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
||||
|
||||
- **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)
|
||||
|
||||
## 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.
|
||||
1. Open the webUI to configure your network scanning preferences.
|
||||
|
||||
## Full Access vs Standard Version
|
||||
|
||||
This **Full Access** version provides:
|
||||
- `full_access: true` - Complete system access
|
||||
- `host_network: true` - Direct host network access
|
||||
- Enhanced privileges (`SYS_ADMIN`, `NET_ADMIN`, `NET_RAW`)
|
||||
- `udev: true` - Hardware device access
|
||||
|
||||
Use this version if you need enhanced network scanning capabilities or if the standard NetAlertX addon doesn't provide sufficient network access for your setup.
|
||||
|
||||
## Support
|
||||
|
||||
Create an issue on github, or ask on the [home assistant community forum](https://community.home-assistant.io/)
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
@@ -1,3 +1,83 @@
|
||||
Recommendation : please backup your database and migrated to this addon https://github.com/jkunczik/home-assistant-omada
|
||||
# Home assistant add-on: Omada
|
||||
|
||||
It is dedicated and seems in active development ; it should be more stable
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
[](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!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||
|
||||
## ⚠️ Migration Notice
|
||||
|
||||
**This addon is no longer actively maintained.**
|
||||
|
||||
**Recommendation:** Please backup your database and migrate to this dedicated addon: https://github.com/jkunczik/home-assistant-omada
|
||||
|
||||
The recommended alternative:
|
||||
- Is dedicated to Omada functionality
|
||||
- Is in active development
|
||||
- Should be more stable and feature-complete
|
||||
- Has better community support
|
||||
|
||||
## About
|
||||
|
||||
This addon provided the TP-Link Omada Controller for managing TP-Link Omada networking equipment including access points, switches, and routers through a centralized web interface.
|
||||
|
||||
The Omada Controller allows you to:
|
||||
- Manage multiple TP-Link Omada devices
|
||||
- Configure wireless networks and VLANs
|
||||
- Monitor network performance and usage
|
||||
- Set up guest networks and access controls
|
||||
- Manage firmware updates
|
||||
- Generate network reports
|
||||
|
||||
## Migration Instructions
|
||||
|
||||
1. **Backup your current data:**
|
||||
- Access your current Omada Controller
|
||||
- Export your configuration and settings
|
||||
- Note down all your network configurations
|
||||
|
||||
2. **Install the recommended addon:**
|
||||
- Add the repository: https://github.com/jkunczik/home-assistant-omada
|
||||
- Install the new Omada addon
|
||||
- Follow their setup instructions
|
||||
|
||||
3. **Import your data:**
|
||||
- Import your backed-up configuration
|
||||
- Verify all devices are properly connected
|
||||
- Test your network functionality
|
||||
|
||||
## Legacy Configuration
|
||||
|
||||
If you still need to use this addon temporarily:
|
||||
|
||||
Webui can be found at `<your-ip>:8088` (HTTP) or `<your-ip>:8043` (HTTPS).
|
||||
|
||||
### Custom Scripts and Environment Variables
|
||||
|
||||
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
||||
|
||||
- **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
|
||||
|
||||
For this legacy addon: Create an issue on github
|
||||
|
||||
For the recommended replacement: Visit https://github.com/jkunczik/home-assistant-omada
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
|
||||
@@ -1,3 +1,61 @@
|
||||
Recommendation : please backup your database and migrated to this addon https://github.com/jkunczik/home-assistant-omada
|
||||
# Home assistant add-on: Omada v3
|
||||
|
||||
It is dedicated and seems in active development ; it should be more stable
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](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)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||
[](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!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||

|
||||
|
||||
## ⚠️ Migration Notice
|
||||
|
||||
**This legacy addon (v3) is no longer actively maintained.**
|
||||
|
||||
**Recommendation:** Please backup your database and migrate to this dedicated addon: https://github.com/jkunczik/home-assistant-omada
|
||||
|
||||
The recommended alternative:
|
||||
- Is dedicated to Omada functionality
|
||||
- Is in active development
|
||||
- Should be more stable and feature-complete
|
||||
- Has better community support
|
||||
- Supports newer Omada Controller versions
|
||||
|
||||
## About
|
||||
|
||||
This addon provided the legacy TP-Link Omada Controller v3.x for managing older TP-Link Omada networking equipment. This version is deprecated and should only be used for legacy systems that cannot be upgraded.
|
||||
|
||||
**Note:** This is the legacy v3 version. Consider migrating to the current Omada addon or the recommended third-party addon for better performance and support.
|
||||
|
||||
## Migration Instructions
|
||||
|
||||
**For Legacy Systems (v3):**
|
||||
1. Backup your current v3 configuration
|
||||
2. Consider upgrading your Omada devices to support newer controller versions
|
||||
3. Migrate to the recommended addon: https://github.com/jkunczik/home-assistant-omada
|
||||
|
||||
**Migration Path:**
|
||||
1. **Backup current data** from your v3 controller
|
||||
2. **Install recommended addon** from the third-party repository
|
||||
3. **Import configuration** and reconnect devices
|
||||
4. **Verify functionality** before removing this legacy addon
|
||||
|
||||
## Legacy Support
|
||||
|
||||
This addon is maintained for compatibility only. No new features will be added.
|
||||
|
||||
For support with migration or the recommended replacement: Visit https://github.com/jkunczik/home-assistant-omada
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
|
||||
Reference in New Issue
Block a user