mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-08-06 05:02:30 +02:00
fix: apply review fixes to Aurral addon
- config.yaml: fix url to point to master, add ingress support, remove download_folder/data_folder from options (set via UI), match lidarr schema style with env_vars passthrough - updater.json: add with upstream v1.76.12 tracking lklynet/aurral - run script: use proper ingress port env var, cleaner startup - README.md: fix install instructions to reference master branch
This commit is contained in:
@@ -1,5 +1,9 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## 1.0.0
|
## 1.76.12-1
|
||||||
|
|
||||||
- Initial Home Assistant add-on release wrapping `ghcr.io/lklynet/aurral:latest`
|
- Initial Home Assistant add-on release
|
||||||
|
- Wraps upstream `ghcr.io/lklynet/aurral:v1.76.12`
|
||||||
|
- Exposes `download_folder` and `data_folder` as configurable paths in the add-on UI
|
||||||
|
- Supports HA Ingress (sidebar access without port forwarding)
|
||||||
|
- Supports amd64 and aarch64
|
||||||
|
|||||||
@@ -9,56 +9,47 @@ for Lidarr — with library-aware recommendations and Navidrome integration.
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Add **alexbelgium's add-on repository** to Home Assistant (if not already added).
|
1. Add **alexbelgium's add-on repository** to Home Assistant:
|
||||||
|
[![Add repository][repo-badge]][repo-url]
|
||||||
2. Go to **Settings → Add-ons → Add-on Store**, find **Aurral**, and click **Install**.
|
2. Go to **Settings → Add-ons → Add-on Store**, find **Aurral**, and click **Install**.
|
||||||
3. Configure the options below, then click **Start**.
|
3. Set the `download_folder` and `data_folder` options (see below), then click **Start**.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
```yaml
|
All options are set in the **Configuration** tab of the add-on UI.
|
||||||
# Host path (under /share) where Aurral writes flow downloads.
|
|
||||||
download_folder: /share/aurral/downloads
|
|
||||||
|
|
||||||
# Host path (under /share) for Aurral's database and persistent config.
|
| Option | Default | Description |
|
||||||
data_folder: /share/aurral/data
|
|---|---|---|
|
||||||
|
| `download_folder` | `/share/aurral/downloads` | Path where Aurral writes flow downloads and Navidrome playlists. Must be under `/share`. |
|
||||||
# Run as this UID/GID — match your host directory ownership.
|
| `data_folder` | `/share/aurral/data` | Path for Aurral's database and persistent config. Must be under `/share`. |
|
||||||
PUID: 1000
|
| `PUID` | `1000` | User ID to run as — match your host directory ownership. |
|
||||||
PGID: 1000
|
| `PGID` | `1000` | Group ID to run as. |
|
||||||
|
| `TRUST_PROXY` | `true` | Set `true` when behind HA ingress or a reverse proxy. |
|
||||||
# Set true if behind HA ingress or a reverse proxy.
|
| `TZ` | *(empty)* | Your timezone, e.g. `Australia/Melbourne`. Leave blank to inherit from HA. |
|
||||||
TRUST_PROXY: "true"
|
| `LIDARR_INSECURE` | `false` | Allow self-signed TLS on your Lidarr instance. |
|
||||||
|
| `AUTH_PROXY_ENABLED` | `false` | Enable reverse-proxy SSO auth. |
|
||||||
# Your timezone, e.g. Australia/Melbourne (leave blank to inherit from HA)
|
| `AUTH_PROXY_HEADER` | *(empty)* | Header carrying the authenticated username, e.g. `X-Forwarded-User`. |
|
||||||
TZ: ""
|
| `AUTH_PROXY_TRUSTED_IPS` | *(empty)* | Comma-separated IPs trusted to send the auth header. |
|
||||||
|
| `env_vars` | `[]` | Extra environment variables passed directly to Aurral. |
|
||||||
# Allow self-signed TLS on your Lidarr instance.
|
|
||||||
LIDARR_INSECURE: "false"
|
|
||||||
|
|
||||||
# Reverse-proxy SSO auth (optional).
|
|
||||||
AUTH_PROXY_ENABLED: "false"
|
|
||||||
AUTH_PROXY_HEADER: ""
|
|
||||||
AUTH_PROXY_TRUSTED_IPS: ""
|
|
||||||
```
|
|
||||||
|
|
||||||
## Volume Mapping
|
## Volume Mapping
|
||||||
|
|
||||||
| Option | HA host path (default) | Container path | Purpose |
|
| Option | Container path | Purpose |
|
||||||
|---|---|---|---|
|
|---|---|---|
|
||||||
| `download_folder` | `/share/aurral/downloads` | `/app/downloads` | Flow output, Navidrome playlists |
|
| `download_folder` | `/app/downloads` | Flow output, Navidrome playlists |
|
||||||
| `data_folder` | `/share/aurral/data` | `/app/backend/data` | Database, settings |
|
| `data_folder` | `/app/backend/data` | Database, settings |
|
||||||
| *(built-in)* | `/media` | `/media` | HA media library (read) |
|
| *(built-in)* `/media` | `/media` | HA media library (read) |
|
||||||
|
|
||||||
## Ports
|
## Ports
|
||||||
|
|
||||||
| Port | Description |
|
| Port | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `3001/tcp` | Aurral Web UI |
|
| `3001/tcp` | Aurral Web UI (also available via HA Ingress sidebar) |
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- **Lidarr** reachable from your HA host
|
- **Lidarr** reachable from your HA host
|
||||||
- **Last.fm API key** for recommendations and metadata
|
- **Last.fm API key** (free) for recommendations and metadata
|
||||||
- Optional: **Navidrome** for flow/playlist library integration
|
- Optional: **Navidrome** for flow/playlist library integration
|
||||||
|
|
||||||
## More Information
|
## More Information
|
||||||
@@ -70,3 +61,5 @@ Full documentation, flows guide, and Spotify import helper:
|
|||||||
[source]: https://github.com/lklynet/aurral
|
[source]: https://github.com/lklynet/aurral
|
||||||
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||||
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||||
|
[repo-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
|
||||||
|
[repo-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
name: Aurral
|
name: Aurral
|
||||||
version: "1.0.0"
|
version: "1.76.12-1"
|
||||||
slug: aurral
|
slug: aurral
|
||||||
description: >-
|
description: >-
|
||||||
Self-hosted music discovery, request management, flows, and playlist
|
Self-hosted music discovery, request management, flows, and playlist
|
||||||
importing for Lidarr with library-aware recommendations and Navidrome
|
importing for Lidarr with library-aware recommendations and Navidrome
|
||||||
integration.
|
integration.
|
||||||
url: https://github.com/petruknw/hassio-addons/blob/feat/aurral-addon/aurral/README.md
|
url: https://github.com/alexbelgium/hassio-addons/blob/master/aurral/README.md
|
||||||
arch:
|
arch:
|
||||||
- aarch64
|
- aarch64
|
||||||
- amd64
|
- amd64
|
||||||
@@ -21,6 +21,10 @@ ports_description:
|
|||||||
|
|
||||||
webui: http://[HOST]:[PORT:3001]
|
webui: http://[HOST]:[PORT:3001]
|
||||||
|
|
||||||
|
ingress: true
|
||||||
|
ingress_port: 3001
|
||||||
|
ingress_stream: false
|
||||||
|
|
||||||
map:
|
map:
|
||||||
- addon_config:rw
|
- addon_config:rw
|
||||||
- share:rw
|
- share:rw
|
||||||
@@ -37,6 +41,7 @@ options:
|
|||||||
AUTH_PROXY_ENABLED: "false"
|
AUTH_PROXY_ENABLED: "false"
|
||||||
AUTH_PROXY_HEADER: ""
|
AUTH_PROXY_HEADER: ""
|
||||||
AUTH_PROXY_TRUSTED_IPS: ""
|
AUTH_PROXY_TRUSTED_IPS: ""
|
||||||
|
env_vars: []
|
||||||
|
|
||||||
schema:
|
schema:
|
||||||
download_folder: str
|
download_folder: str
|
||||||
@@ -49,6 +54,9 @@ schema:
|
|||||||
AUTH_PROXY_ENABLED: str?
|
AUTH_PROXY_ENABLED: str?
|
||||||
AUTH_PROXY_HEADER: str?
|
AUTH_PROXY_HEADER: str?
|
||||||
AUTH_PROXY_TRUSTED_IPS: str?
|
AUTH_PROXY_TRUSTED_IPS: str?
|
||||||
|
env_vars:
|
||||||
|
- name: match(^[A-Za-z0-9_]+$)
|
||||||
|
value: str?
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
PUID: "1000"
|
PUID: "1000"
|
||||||
|
|||||||
@@ -3,27 +3,42 @@
|
|||||||
# Start Aurral with configuration from HA add-on options.
|
# Start Aurral with configuration from HA add-on options.
|
||||||
# ==============================================================
|
# ==============================================================
|
||||||
|
|
||||||
|
# --- Volume paths (user-configurable in the add-on UI) -------
|
||||||
DOWNLOAD_FOLDER=$(bashio::config 'download_folder')
|
DOWNLOAD_FOLDER=$(bashio::config 'download_folder')
|
||||||
DATA_FOLDER=$(bashio::config 'data_folder')
|
DATA_FOLDER=$(bashio::config 'data_folder')
|
||||||
|
|
||||||
|
# --- Process identity ----------------------------------------
|
||||||
PUID=$(bashio::config 'PUID')
|
PUID=$(bashio::config 'PUID')
|
||||||
PGID=$(bashio::config 'PGID')
|
PGID=$(bashio::config 'PGID')
|
||||||
|
|
||||||
|
# --- Networking ----------------------------------------------
|
||||||
TRUST_PROXY=$(bashio::config 'TRUST_PROXY')
|
TRUST_PROXY=$(bashio::config 'TRUST_PROXY')
|
||||||
|
|
||||||
|
# --- Optional settings ---------------------------------------
|
||||||
TZ=$(bashio::config 'TZ' '')
|
TZ=$(bashio::config 'TZ' '')
|
||||||
LIDARR_INSECURE=$(bashio::config 'LIDARR_INSECURE' 'false')
|
LIDARR_INSECURE=$(bashio::config 'LIDARR_INSECURE' 'false')
|
||||||
AUTH_PROXY_ENABLED=$(bashio::config 'AUTH_PROXY_ENABLED' 'false')
|
AUTH_PROXY_ENABLED=$(bashio::config 'AUTH_PROXY_ENABLED' 'false')
|
||||||
AUTH_PROXY_HEADER=$(bashio::config 'AUTH_PROXY_HEADER' '')
|
AUTH_PROXY_HEADER=$(bashio::config 'AUTH_PROXY_HEADER' '')
|
||||||
AUTH_PROXY_TRUSTED_IPS=$(bashio::config 'AUTH_PROXY_TRUSTED_IPS' '')
|
AUTH_PROXY_TRUSTED_IPS=$(bashio::config 'AUTH_PROXY_TRUSTED_IPS' '')
|
||||||
|
|
||||||
# Ensure host-side directories exist
|
# --- Ensure host-side directories exist ----------------------
|
||||||
|
bashio::log.info "Creating data directories if missing..."
|
||||||
mkdir -p "${DOWNLOAD_FOLDER}" "${DATA_FOLDER}"
|
mkdir -p "${DOWNLOAD_FOLDER}" "${DATA_FOLDER}"
|
||||||
|
|
||||||
# Symlink HA volume paths into the locations Aurral expects
|
# --- Wire HA share paths into the paths Aurral expects -------
|
||||||
rm -rf /app/downloads && ln -sf "${DOWNLOAD_FOLDER}" /app/downloads
|
# Aurral hard-codes /app/downloads and /app/backend/data internally.
|
||||||
rm -rf /app/backend/data && ln -sf "${DATA_FOLDER}" /app/backend/data
|
# We symlink from those paths to the user-configured share locations
|
||||||
|
# so data persists across add-on updates and restarts.
|
||||||
|
rm -rf /app/downloads
|
||||||
|
ln -sf "${DOWNLOAD_FOLDER}" /app/downloads
|
||||||
|
|
||||||
bashio::log.info "Starting Aurral"
|
rm -rf /app/backend/data
|
||||||
|
ln -sf "${DATA_FOLDER}" /app/backend/data
|
||||||
|
|
||||||
|
bashio::log.info "Starting Aurral v$(bashio::addon.version)"
|
||||||
bashio::log.info " Downloads : ${DOWNLOAD_FOLDER}"
|
bashio::log.info " Downloads : ${DOWNLOAD_FOLDER}"
|
||||||
bashio::log.info " Data : ${DATA_FOLDER}"
|
bashio::log.info " Data : ${DATA_FOLDER}"
|
||||||
|
bashio::log.info " PUID/PGID : ${PUID}/${PGID}"
|
||||||
|
|
||||||
exec env \
|
exec env \
|
||||||
PUID="${PUID}" \
|
PUID="${PUID}" \
|
||||||
@@ -35,4 +50,4 @@ exec env \
|
|||||||
AUTH_PROXY_ENABLED="${AUTH_PROXY_ENABLED}" \
|
AUTH_PROXY_ENABLED="${AUTH_PROXY_ENABLED}" \
|
||||||
AUTH_PROXY_HEADER="${AUTH_PROXY_HEADER}" \
|
AUTH_PROXY_HEADER="${AUTH_PROXY_HEADER}" \
|
||||||
AUTH_PROXY_TRUSTED_IPS="${AUTH_PROXY_TRUSTED_IPS}" \
|
AUTH_PROXY_TRUSTED_IPS="${AUTH_PROXY_TRUSTED_IPS}" \
|
||||||
docker-entrypoint.sh node server.js
|
node /app/backend/server.js
|
||||||
|
|||||||
8
aurral/updater.json
Normal file
8
aurral/updater.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"last_update": "20-05-2026",
|
||||||
|
"repository": "alexbelgium/hassio-addons",
|
||||||
|
"slug": "aurral",
|
||||||
|
"source": "github",
|
||||||
|
"upstream_repo": "lklynet/aurral",
|
||||||
|
"upstream_version": "1.76.12"
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user