docker-documentation/images/docker-booksonic-air.md

9.2 KiB
Executable File

title
booksonic-air

linuxserver/booksonic-air

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of:

  • Booksonic Air - A server for streaming your audiobooks, successor to the original Booksonic server and based on Airsonic.
  • Booksonic App - An DSub based Android app for connection to Booksonic-Air servers.

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/booksonic-air: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:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf

Application Setup

Whilst this is a more up to date rebase of the original Booksonic server, upgrading in place is not supported and a fresh install has been recommended. Default user/pass is admin/admin

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
version: "2.1"
services:
  booksonic-air:
    image: lscr.io/linuxserver/booksonic-air:latest
    container_name: booksonic-air
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - CONTEXT_PATH=url-base #optional
    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-air \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e CONTEXT_PATH=url-base `#optional` \
  -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-air:latest

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 Application WebUI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
CONTEXT_PATH=url-base Base url for use with reverse proxies etc.

Volume Mappings (-v)

Volume Function
/config Configuration files.
/audiobooks Audiobooks.
/podcasts Podcasts.
/othermedia Other media.

Miscellaneous Options

Parameter Function

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

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 booksonic-air /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f booksonic-air
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' booksonic-air
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/booksonic-air:latest

Versions

  • 25.12.22: - Rebase to Alpine 3.17, migrate to s6v3, bump jre to 11, deprecate armhf.
  • 18.04.22: - Rebase to Alpine 3.15.
  • 15.09.20: - Initial Release.