Portainer Templates logo

Portainer Templates

Airsonic-advanced Airsonic-advanced

Container

Media ServersMusic

Airsonic-advanced is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.

Image details

Pulls: 430k
Architecture: amd64, arm64
Image size: 246 MB
Latest: 11.1.4
User: linuxserverci
Created: Jan 11, 2022
Updated: 21 days ago
Status: active

Source details

Repo: kagemomiji/airsonic-advanced
Stars: 267
Forks: 23
Language: Java
License: GPL-3.0
Latest: 11.1.4 · 1 years ago
Updated: 2 days ago

Configuration

Type
Container
Platform
linux
Image
linuxserver/airsonic-advanced:latest
Ports
4040:4040/tcp
Volumes
/config : /srv/lsio/airsonic-advanced/config/music : /srv/lsio/airsonic-advanced/music/playlists : /srv/lsio/airsonic-advanced/playlists/podcasts : /srv/lsio/airsonic-advanced/podcasts/media : /srv/lsio/airsonic-advanced/media
Env vars
PUID=1000PGID=1000TZ=Etc/UTCCONTEXT_PATH=JAVA_OPTS=
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/airsonic-advanced/config
mkdir -p /srv/lsio/airsonic-advanced/music
mkdir -p /srv/lsio/airsonic-advanced/playlists
mkdir -p /srv/lsio/airsonic-advanced/podcasts
mkdir -p /srv/lsio/airsonic-advanced/media

Standalone Install

Select an install method, to see config/commands for deploying Airsonic-advanced

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Airsonic-advanced, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see kagemomiji/airsonic-advanced for app-specific guidance.

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/airsonic-advanced

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
Airsonic-advanced is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
airsonic-advanced

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/airsonic-advanced:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
ArchitectureAvailableTag
x86-64✅amd64-\
arm64✅arm64v8-\

Application Setup

We don't formally support upgrading from Airsonic to Airsonic Advanced, it may or may not work for you and we'd recommend making backups before attempting this. Following the upgrade you may experience a forced rescan of your library so take this into account if you have a lot of files.
Please see notes about upgrading from v10 to v11 here
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Extra java options can be passed with the JAVAOPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m". For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.
Note that if you want to use Airsonic's Java jukebox player, then PGID will need to match the group of your sound device (e.g. /dev/snd).

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  airsonic-advanced:
    image: lscr.io/linuxserver/airsonic-advanced:latest
    container_name: airsonic-advanced
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - CONTEXT_PATH= #optional
      - JAVA_OPTS= #optional
    volumes:
      - /path/to/airsonic-advanced/config:/config
      - /path/to/music:/music
      - /path/to/playlists:/playlists
      - /path/to/podcasts:/podcasts
      - /path/to/other media:/media #optional
    ports:
      - 4040:4040
    devices:
      - /dev/snd:/dev/snd #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=airsonic-advanced \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e CONTEXT_PATH= `#optional` \
  -e JAVA_OPTS= `#optional` \
  -p 4040:4040 \
  -v /path/to/airsonic-advanced/config:/config \
  -v /path/to/music:/music \
  -v /path/to/playlists:/playlists \
  -v /path/to/podcasts:/podcasts \
  -v /path/to/other media:/media `#optional` \
  --device /dev/snd:/dev/snd `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/airsonic-advanced:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
ParameterFunction
-p 4040:4040WebUI
-e PUID=1000for UserID - see below for explanation
-e PGID=1000for GroupID - see below for explanation
-e TZ=Etc/UTCspecify a timezone to use, see this list.
-e CONTEXTPATH=For setting url-base in reverse proxy setups.
-e JAVAOPTS=For passing additional java options.
-v /configConfiguration file location.
-v /musicLocation of music.
-v /playlistsLocation for playlists to be saved to.
-v /podcastsLocation of podcasts.
-v /mediaLocation of other media.
--device /dev/sndOnly needed to pass your host sound device to Airsonic's Java jukebox player.
--read-only=trueRun container with a read-only filesystem. Please read the docs.
--user=1000:1000Run container with a non-root user. Please read the docs.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:
id your_user

Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:
```bash
docker exec -it airsonic-advanced /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f airsonic-advanced
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic-advanced
```
  • Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/airsonic-advanced:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

  • Update images:
* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull airsonic-advanced
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d airsonic-advanced
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/airsonic-advanced:latest
```
  • Stop the running container:
```bash
docker stop airsonic-advanced
```
  • Delete the container:
```bash
docker rm airsonic-advanced
```
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images:
```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-airsonic-advanced.git
cd docker-airsonic-advanced
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/airsonic-advanced:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 21.12.24: - Rebase to Alpine 3.21. Switch upstream to track https://github.com/kagemomiji/airsonic-advanced.
  • 24.05.24: - Rebase to Alpine 3.20.
  • 20.03.24: - Rebase to Alpine 3.19.
  • 30.05.23: - Rebase to Alpine 3.18.
  • 11.02.23: - Rebase to Alpine 3.17.
  • 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
  • 25.07.22: - Add vorbis-tools.
  • 02.01.22: - Initial Release.

Serve Airsonic-advanced on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying airsonic-advanced.example.com to http://Airsonic-advanced:4040

Add this to your Caddyfile

airsonic-advanced.example.com {
	reverse_proxy http://Airsonic-advanced:4040
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Airsonic-advanced
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:4040 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :4040
  • Stop the other service, or pick a different host port. In 4040:4040 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:4040. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Airsonic-advanced can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 4040

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/airsonic-advanced/config (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/airsonic-advanced:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Airsonic-advanced --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

CONTEXT_PATH, JAVA_OPTS have no default value, and Airsonic-advanced may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Airsonic-advanced runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Airsonic-advanced needs bundled into one download. This template pulls linuxserver/airsonic-advanced:latest, which Docker fetches once (about 246 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Airsonic-advanced's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 11.1.4. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 4040:4040 means it's reachable on port 4040 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 4040:4040

Volumes

A volume is where Airsonic-advanced keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /srv/lsio/airsonic-advanced/config on the host
  • /music from /srv/lsio/airsonic-advanced/music on the host
  • /playlists from /srv/lsio/airsonic-advanced/playlists on the host
  • /podcasts from /srv/lsio/airsonic-advanced/podcasts on the host
  • /media from /srv/lsio/airsonic-advanced/media on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Airsonic-advanced takes 5 of them, and 2 need a value before it'll start properly:

  • PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
  • PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
  • TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.
  • CONTEXT_PATH, needs a value. For setting url-base in reverse proxy setups. [OPTIONAL]
  • JAVA_OPTS, needs a value. For passing additional java options. [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Airsonic-advanced after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Airsonic-advanced sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Airsonic-advanced. That's what you'll spot in the containers list and use in commands like docker logs Airsonic-advanced.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Airsonic-advanced is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Airsonic-advanced up. Add the template list to Portainer once, then deploying Airsonic-advanced is a click rather than a wall of config.