Booksonic

Container

Booksonic is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic

Image details

Pulls: 50.8M

Architecture: amd64, arm64, arm/v7, arm, arm64/v8

Image size: 232 MB

Latest: 1.2.20220211

User: linuxserver

Created: Dec 13, 2016

Updated: 4 years ago

Status: active

Configuration

Type

Container

Platform

linux

Image

linuxserver/booksonic:latest

Ports

4040:4040/tcp

Volumes

/books : /portainer/Books/podcast : /portainer/Files/Podcasts/config : /portainer/Files/AppData/Config/Booksonic

Env vars

PUID=1000PGID=100CONTEXT_PATH=booksonic

Restart

unless-stopped

Template by mikestraney

Standalone Install

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

Install on Portainer

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

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

Template Import URL

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

Show Me

More install options in our documentation.

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.
Fleet - an online web interface which displays all of our maintained images.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

DEPRECATION NOTICE

This image is deprecated. We will not offer support for this image and it will not be updated. Please migrate to

linuxserver/booksonic

Booksonic is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic.

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 lscr.io/linuxserver/booksonic 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

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.

Tag	Description
latest	Stable Booksonic releases
prerelease	Booksonic Pre-releases

Application Setup

Default user/pass is admin/admin

Usage

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

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

---
version: "2.1"
services:
  booksonic:
    image: lscr.io/linuxserver/booksonic
    container_name: booksonic
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - CONTEXT_PATH=url-base
    volumes:
      - </path/to/appdata/config>:/config
      - </path/to/audiobooks>:/audiobooks
      - </path/to/podcasts>:/podcasts
      - </path/to/othermedia>:/othermedia
    ports:
      - 4040:4040
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=booksonic \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e CONTEXT_PATH=url-base \
  -p 4040:4040 \
  -v </path/to/appdata/config>:/config \
  -v </path/to/audiobooks>:/audiobooks \
  -v </path/to/podcasts>:/podcasts \
  -v </path/to/othermedia>:/othermedia \
  --restart unless-stopped \
  lscr.io/linuxserver/booksonic

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.

Parameter	Function
`-p 4040`	Application WebUI
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Europe/London`	Specify a timezone to use EG Europe/London.
`-e CONTEXTPATH=url-base`	Base url for use with reverse proxies etc.
`-v /config`	Configuration files.
`-v /audiobooks`	Audiobooks.
`-v /podcasts`	Podcasts.
`-v /othermedia`	Other media.

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)

Docker 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 booksonic /bin/bash
To monitor the logs of the container in realtime: docker logs -f booksonic
container version number

docker inspect -f '{{ index .Config.Labels "build_version" }}' booksonic
image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/booksonic

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 Compose

Update all images: docker-compose pull

or update a single image: docker-compose pull booksonic
Let compose update all containers as necessary: docker-compose up -d
or update a single container: docker-compose up -d booksonic

You can also remove the old dangling images: docker image prune

Via Docker Run

Update the image: docker pull lscr.io/linuxserver/booksonic
Stop the running container: docker stop booksonic
Delete the container: docker rm booksonic
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: docker image prune

Via Watchtower auto-updater (only use 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 run:

```bash docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once booksonic ```

You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

Image Update Notifications - Diun (Docker Image Update Notifier)

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-booksonic.git
cd docker-booksonic
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/booksonic:latest .

The ARM variants can be built on x8664 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
06.05.21: - This image is now deprecated. Please migrate to https://github.com/linuxserver/docker-booksonic-air
11.08.20: - Changed upstream github repo location
22.12.19: - Revert to pulling in external war, upgrade jetty.
30.04.19: - Switching to build war from source, use stable booksonic releases.
24.03.19: - Switching to new Base images, shift to arm32v7 tag.
16.01.19: - Adding pipeline logic and multi arch.
05.01.19: - Linting fixes.
27.08.18: - Rebase to ubuntu bionic.
06.12.17: - Rebase to alpine 3.7.
11.07.17: - Rebase to alpine 3.6.
07.02.17: - Rebase to alpine 3.5.
13.12.16: - Initial Release.

Serve Booksonic 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.

Proxy Domain App port Upstream

Proxying booksonic.example.com to http://booksonic:4040

Add this to your Caddyfile

booksonic.example.com {
	reverse_proxy http://booksonic: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 booksonic
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, booksonic 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:100 /portainer/Books (and the same for the other mapped folders)
Or set the PUID and PGID variables (defaults 1000:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/booksonic: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/v7, 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.

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 booksonic --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

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

Bug within the app: Open an issue within booksonic's repo
Template not working: Open an issue on mikestraney/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

A single container

Booksonic 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 Booksonic needs bundled into one download. This template pulls linuxserver/booksonic:latest, which Docker fetches once (about 232 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. Booksonic'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 1.2.20220211. 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/v7, 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. 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 Booksonic 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:

/books from /portainer/Books on the host
/podcast from /portainer/Files/Podcasts on the host
/config from /portainer/Files/AppData/Config/Booksonic on the host

Environment variables

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

PUID, defaults to 1000
PGID, defaults to 100
CONTEXT_PATH, defaults to booksonic

Restart policy

The restart policy here is unless-stopped, so Docker restarts Booksonic 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 Booksonic 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 booksonic. That's what you'll spot in the containers list and use in commands like docker logs booksonic.

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 Booksonic up. Add the template list to Portainer once, then deploying Booksonic is a click rather than a wall of config.

Booksonic

Image details

Configuration

Standalone Install

Install on Portainer

Template Import URL

Container Documentation

DEPRECATION NOTICE

linuxserver/booksonic

Supported Architectures

Version Tags

Application Setup

Usage

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

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Via Watchtower auto-updater (only use if you don't remember the original parameters)

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

Recent versions

Proxy configurator

Troubleshooting

Check the logs first

Port already in use

Running but the page won't load

Permission denied on volumes

Image won't pull

"exec format error"

Container keeps restarting

Raise an issue

Config glossary

A single container

The app image

Where the image comes from

Version tags

Which machines it runs on

Ports

Volumes

Environment variables

Restart policy

Users and permissions

Networking

Container name

Platform

Portainer app templates

Similar apps