Images

linuxserver/airsonic

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry MicroBadger Layers Docker Pulls Docker Stars Jenkins Build LSIO CI

Airsonic 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.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/airsonic 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:

Architecture

Tag

x86-64

amd64-latest

arm64

arm64v8-latest

armhf

arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
airsonic:
image: ghcr.io/linuxserver/airsonic
container_name: airsonic
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- CONTEXT_PATH=<URL_BASE> #optional
- JAVA_OPTS=<options> #optional
volumes:
- </path/to/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

docker run -d \
--name=airsonic \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e CONTEXT_PATH=<URL_BASE> `#optional` \
-e JAVA_OPTS=<options> `#optional` \
-p 4040:4040 \
-v </path/to/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 \
ghcr.io/linuxserver/airsonic

Parameters

Docker images 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.

Ports (-p)

Parameter

Function

4040

WebUI

Environment Variables (-e)

Env

Function

PUID=1000

for UserID - see below for explanation

PGID=1000

for GroupID - see below for explanation

TZ=Europe/London

Specify a timezone to use EG Europe/London.

CONTEXT_PATH=<URL_BASE>

For setting url-base in reverse proxy setups.

JAVA_OPTS=<options>

For passing additional java options.

Volume Mappings (-v)

Volume

Function

/config

Configuration file location.

/music

Location of music.

/playlists

Location for playlists to be saved to.

/podcasts

Location of podcasts.

/media

Location of other media.

Device Mappings (--device)

Parameter

Function

/dev/snd

Only needed to pass your host sound device to Airsonic's Java jukebox player.

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__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

Access WebUI at <your-ip>:4040.

Default user/pass is admin/admin

Extra java options can be passed with the JAVA_OPTS 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).

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:

    • docker exec -it airsonic /bin/bash

  • To monitor the logs of the container in realtime:

    • docker logs -f airsonic

  • Container version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic

  • Image version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/airsonic

Versions

  • 24.03.19: - Switching to new Base images, shift to arm32v7 tag.

  • 26.01.19: - Add pipeline logic and multi arch.

  • 05.01.19: - Linting fixes.

  • 27.08.18: - Use new inhouse java baseimage for quicker builds.

  • 23.08.18: - Rebase to ubuntu bionic for increased performance across all arch's.

  • 22.04.18: - Add the forgotten JAVA_OPTS to the run command.

  • 29.12.17: - Initial Release.