diff --git a/aurral/CHANGELOG.md b/aurral/CHANGELOG.md index f29fdb212e..e5fa16a1a1 100644 --- a/aurral/CHANGELOG.md +++ b/aurral/CHANGELOG.md @@ -1,5 +1,9 @@ # 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 diff --git a/aurral/README.md b/aurral/README.md index 1499657d29..fe8a8832d3 100644 --- a/aurral/README.md +++ b/aurral/README.md @@ -9,56 +9,47 @@ for Lidarr — with library-aware recommendations and Navidrome integration. ## 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**. -3. Configure the options below, then click **Start**. +3. Set the `download_folder` and `data_folder` options (see below), then click **Start**. ## Configuration -```yaml -# Host path (under /share) where Aurral writes flow downloads. -download_folder: /share/aurral/downloads +All options are set in the **Configuration** tab of the add-on UI. -# Host path (under /share) for Aurral's database and persistent config. -data_folder: /share/aurral/data - -# Run as this UID/GID — match your host directory ownership. -PUID: 1000 -PGID: 1000 - -# Set true if behind HA ingress or a reverse proxy. -TRUST_PROXY: "true" - -# Your timezone, e.g. Australia/Melbourne (leave blank to inherit from HA) -TZ: "" - -# 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: "" -``` +| Option | Default | Description | +|---|---|---| +| `download_folder` | `/share/aurral/downloads` | Path where Aurral writes flow downloads and Navidrome playlists. Must be under `/share`. | +| `data_folder` | `/share/aurral/data` | Path for Aurral's database and persistent config. Must be under `/share`. | +| `PUID` | `1000` | User ID to run as — match your host directory ownership. | +| `PGID` | `1000` | Group ID to run as. | +| `TRUST_PROXY` | `true` | Set `true` when behind HA ingress or a reverse proxy. | +| `TZ` | *(empty)* | Your timezone, e.g. `Australia/Melbourne`. Leave blank to inherit from HA. | +| `LIDARR_INSECURE` | `false` | Allow self-signed TLS on your Lidarr instance. | +| `AUTH_PROXY_ENABLED` | `false` | Enable reverse-proxy SSO auth. | +| `AUTH_PROXY_HEADER` | *(empty)* | Header carrying the authenticated username, e.g. `X-Forwarded-User`. | +| `AUTH_PROXY_TRUSTED_IPS` | *(empty)* | Comma-separated IPs trusted to send the auth header. | +| `env_vars` | `[]` | Extra environment variables passed directly to Aurral. | ## Volume Mapping -| Option | HA host path (default) | Container path | Purpose | -|---|---|---|---| -| `download_folder` | `/share/aurral/downloads` | `/app/downloads` | Flow output, Navidrome playlists | -| `data_folder` | `/share/aurral/data` | `/app/backend/data` | Database, settings | -| *(built-in)* | `/media` | `/media` | HA media library (read) | +| Option | Container path | Purpose | +|---|---|---| +| `download_folder` | `/app/downloads` | Flow output, Navidrome playlists | +| `data_folder` | `/app/backend/data` | Database, settings | +| *(built-in)* `/media` | `/media` | HA media library (read) | ## Ports | Port | Description | |---|---| -| `3001/tcp` | Aurral Web UI | +| `3001/tcp` | Aurral Web UI (also available via HA Ingress sidebar) | ## Requirements - **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 ## More Information @@ -70,3 +61,5 @@ Full documentation, flows guide, and Spotify import helper: [source]: https://github.com/lklynet/aurral [aarch64-shield]: https://img.shields.io/badge/aarch64-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 diff --git a/aurral/config.yaml b/aurral/config.yaml index 31d3157d73..ce7d77219f 100644 --- a/aurral/config.yaml +++ b/aurral/config.yaml @@ -1,11 +1,11 @@ name: Aurral -version: "1.0.0" +version: "1.76.12-1" slug: aurral description: >- Self-hosted music discovery, request management, flows, and playlist importing for Lidarr with library-aware recommendations and Navidrome 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: - aarch64 - amd64 @@ -21,6 +21,10 @@ ports_description: webui: http://[HOST]:[PORT:3001] +ingress: true +ingress_port: 3001 +ingress_stream: false + map: - addon_config:rw - share:rw @@ -37,6 +41,7 @@ options: AUTH_PROXY_ENABLED: "false" AUTH_PROXY_HEADER: "" AUTH_PROXY_TRUSTED_IPS: "" + env_vars: [] schema: download_folder: str @@ -49,6 +54,9 @@ schema: AUTH_PROXY_ENABLED: str? AUTH_PROXY_HEADER: str? AUTH_PROXY_TRUSTED_IPS: str? + env_vars: + - name: match(^[A-Za-z0-9_]+$) + value: str? environment: PUID: "1000" diff --git a/aurral/rootfs/etc/services.d/aurral/run b/aurral/rootfs/etc/services.d/aurral/run index eb1e66e3ed..56ea72b75e 100644 --- a/aurral/rootfs/etc/services.d/aurral/run +++ b/aurral/rootfs/etc/services.d/aurral/run @@ -3,27 +3,42 @@ # Start Aurral with configuration from HA add-on options. # ============================================================== +# --- Volume paths (user-configurable in the add-on UI) ------- DOWNLOAD_FOLDER=$(bashio::config 'download_folder') DATA_FOLDER=$(bashio::config 'data_folder') + +# --- Process identity ---------------------------------------- PUID=$(bashio::config 'PUID') PGID=$(bashio::config 'PGID') + +# --- Networking ---------------------------------------------- TRUST_PROXY=$(bashio::config 'TRUST_PROXY') + +# --- Optional settings --------------------------------------- TZ=$(bashio::config 'TZ' '') LIDARR_INSECURE=$(bashio::config 'LIDARR_INSECURE' 'false') AUTH_PROXY_ENABLED=$(bashio::config 'AUTH_PROXY_ENABLED' 'false') AUTH_PROXY_HEADER=$(bashio::config 'AUTH_PROXY_HEADER' '') 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}" -# Symlink HA volume paths into the locations Aurral expects -rm -rf /app/downloads && ln -sf "${DOWNLOAD_FOLDER}" /app/downloads -rm -rf /app/backend/data && ln -sf "${DATA_FOLDER}" /app/backend/data +# --- Wire HA share paths into the paths Aurral expects ------- +# Aurral hard-codes /app/downloads and /app/backend/data internally. +# 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 " Data : ${DATA_FOLDER}" +bashio::log.info " PUID/PGID : ${PUID}/${PGID}" exec env \ PUID="${PUID}" \ @@ -35,4 +50,4 @@ exec env \ AUTH_PROXY_ENABLED="${AUTH_PROXY_ENABLED}" \ AUTH_PROXY_HEADER="${AUTH_PROXY_HEADER}" \ AUTH_PROXY_TRUSTED_IPS="${AUTH_PROXY_TRUSTED_IPS}" \ - docker-entrypoint.sh node server.js + node /app/backend/server.js diff --git a/aurral/updater.json b/aurral/updater.json new file mode 100644 index 0000000000..075b8fcc20 --- /dev/null +++ b/aurral/updater.json @@ -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" +}