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
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.
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/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 |
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 |
Here are some example snippets to help you get started creating a container.
docker create \
--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 \
linuxserver/booksonic
Compatible with docker-compose v2 schemas.
---
version: "2.1"
services:
booksonic:
image: 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
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 CONTEXT_PATH=url-base |
Base url for use with reverse proxies etc. |
-v /config |
Configuration files. |
-v /audiobooks |
Audiobooks. |
-v /podcasts |
Podcasts. |
-v /othermedia |
Other media. |
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.
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.
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)
Default user/pass is admin/admin
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
- 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" }}' linuxserver/booksonic
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:
- Update the image:
docker pull linuxserver/booksonic - Stop the running container:
docker stop booksonic - Delete the container:
docker rm booksonic - Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved) - Start the new container:
docker start booksonic - You can also remove the old dangling images:
docker image prune
- Update all images:
docker-compose pull- or update a single image:
docker-compose pull booksonic
- or update a single image:
- Let compose update all containers as necessary:
docker-compose up -d- or update a single container:
docker-compose up -d booksonic
- or update a single container:
- You can also remove the old dangling images:
docker image prune
- Pull the latest image at its tag and replace it with the same env variables in one run:
docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once booksonic
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.
- You can also remove the old dangling images:
docker image prune
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 linuxserver/booksonic:latest .
The ARM variants can be built on x86_64 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.
- 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.