Portainer Templates logo

Portainer Templates

libresonic libresonic

Container

Music

Libresonic is a free, web-based media streamer, providing ubiqutious 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. /music = Location of music. /media = Location of other media. /podcasts = Location of podcasts. /playlists = Location for playlists storage. CONTEXTPATH is for setting url-base in reverse proxy setups - (optional) Default user/pass is admin/admin

Image details

Pulls: 14.5M
Architecture: amd64, arm64, arm, arm64/v8
Image size: 276 MB
User: linuxserver
Created: Nov 17, 2016
Updated: 7 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/libresonic:latest
Ports
4040/tcp
Volumes
/music/playlists/podcasts/media/config
Env vars
CONTEXT_PATH=PUID=1000PGID=1000TZ=America/Chicago

Template by dnburgess

Standalone Install

Select an install method, to see config/commands for deploying libresonic

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 libresonic, 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.

linuxserver.io
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:
  • Discord - realtime support / chat with the community and the team.
  • IRC - on freenode at #linuxserver.io. Our primary support channel is Discord.
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!

linuxserver/libresonic

Docker Pulls Docker Stars Build Status
THIS IMAGE IS DEPRECATED. PLEASE USE AIRSONIC linuxserver/airsonic Libresonic is a free, web-based media streamer, providing ubiqutious 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.
libresonic

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 linuxserver/libresonic 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:
ArchitectureTag
x86-64amd64-latest
arm64arm64v8-latest
armhfarm32v7-latest

Usage

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

docker

docker create \
  --name=libresonic \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e CONTEXT_PATH=<URL_BASE> `#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` \
  --restart unless-stopped \
  linuxserver/libresonic

docker-compose

Compatible with docker-compose v2 schemas.

```

version: "2" services: libresonic:
image: linuxserver/libresonic
container_name: libresonic
environment:
  - PUID=1000
  - PGID=1000
  - TZ=Europe/London
  - CONTEXT_PATH=<URL_BASE> #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
restart: unless-stopped
## Parameters

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


<table><thead><tr><th>Parameter</th><th>Function</th></tr></thead><tbody><tr><td><code>-p 4040</code></td><td>WebUI</td></tr><tr><td><code>-e PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><td><code>-e PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><td><code>-e TZ=Europe/London</code></td><td>Specify a timezone to use EG Europe/London.</td></tr><tr><td><code>-e CONTEXT_PATH=<URL_BASE></code></td><td>For setting url-base in reverse proxy setups.</td></tr><tr><td><code>-v /config</code></td><td>Configuration file location.</td></tr><tr><td><code>-v /music</code></td><td>Location of music.</td></tr><tr><td><code>-v /playlists</code></td><td>Location for playlists to be saved to.</td></tr><tr><td><code>-v /podcasts</code></td><td>Location of podcasts.</td></tr><tr><td><code>-v /media</code></td><td>Location of other media.</td></tr></tbody></table>

## 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

Support Info

  • Shell access whilst the container is running: docker exec -it libresonic /bin/bash
  • To monitor the logs of the container in realtime: docker logs -f libresonic
  • container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' libresonic
  • image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/libresonic

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 (ie. nextcloud, plex), 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 Run/Create

  • Update the image: docker pull linuxserver/libresonic
  • Stop the running container: docker stop libresonic
  • Delete the container: docker rm libresonic
  • Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • Start the new container: docker start libresonic
  • You can also remove the old dangling images: docker image prune

Via Taisun auto-updater (especially useful if you don't remember the original parameters)

  • Pull the latest image at its tag and replace it with the same env variables in one shot:
``` docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock taisun/updater \ --oneshot libresonic `` * You can also remove the old dangling images: docker image prune`

Via Docker Compose

  • Update all images: docker-compose pull
or update a single image: docker-compose pull libresonic
  • Let compose update all containers as necessary: docker-compose up -d
or update a single container: docker-compose up -d libresonic
  • You can also remove the old dangling images: docker image prune

Versions

  • 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 15.01.19: - Pull war from github, adding pipeline multi arch builds.
  • 05.01.19: - Linting fixes.
  • 27.08.18: - Rebase to ubuntu bionic.
  • 12.12.17: - Rebase to alpine 3.7.
  • 11.07.17: - Rebase to alpine 3.6.
  • 12.05.17: - Add annotation timeout (primarily for armhf and lower powered hosts).
  • 08.02.17: - Rebase to alpine 3.5.
  • 04.12.16: - Update jetty runner version.
  • 29.11.16: - Switch to building from release tags following v6.1 stable release.
  • 17.11.16: - Initial Release.

Serve libresonic 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 libresonic.example.com to http://libresonic:4040

Add this to your Caddyfile

libresonic.example.com {
	reverse_proxy http://libresonic: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 <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 4040/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Image won't pull

Test the pull directly on the host: docker pull linuxserver/libresonic: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, arm, arm64/v8
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Raise an issue

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

A single container

libresonic 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 libresonic needs bundled into one download. This template pulls linuxserver/libresonic:latest, which Docker fetches once (about 276 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. libresonic'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. 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, arm, arm64/v8, 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. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 4040, published on a random host port

Volumes

A volume is where libresonic 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:

  • /music as a volume Docker manages for you
  • /playlists as a volume Docker manages for you
  • /podcasts as a volume Docker manages for you
  • /media as a volume Docker manages for you
  • /config as a volume Docker manages for you

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. libresonic takes 4 of them, all with defaults you can leave alone or tweak:

  • CONTEXT_PATH, needs a value
  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • TZ, defaults to America/Chicago

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 libresonic sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

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.

Portainer app templates

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