LAB-linuxserver/docker-documentation
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-documentation.git synced 2026-02-19 18:14:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Bot Updating Documentation

Browse Source
This commit is contained in:
LinuxServer-CI 2021-04-16 07:41:38 +00:00
parent 4ecdf5a28a
commit b6cf5f5ca4
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
images/docker-booksonic.md
View File

@ -1,6 +1,9 @@
---
title: booksonic
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-booksonic/blob/master/.github/CONTRIBUTING.md -->
# [linuxserver/booksonic](https://github.com/linuxserver/docker-booksonic)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-booksonic.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-booksonic)
@ -14,7 +17,6 @@ title: booksonic
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fbooksonic%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/booksonic/latest/index.html)
[Booksonic](http://booksonic.org) 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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
@ -38,6 +40,9 @@ This image provides various versions that are available via tags. `latest` tag u
| 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 from this image.
@ -70,7 +75,7 @@ services:
### docker cli
```
```bash
docker run -d \
--name=booksonic \
-e PUID=1000 \
@ -86,7 +91,6 @@ docker run -d \
ghcr.io/linuxserver/booksonic
```
## 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.
@ -97,7 +101,6 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `4040` | Application WebUI |
### Environment Variables (`-e`)
| Env | Function |
@ -116,15 +119,13 @@ Docker images are configured using parameters passed at runtime (such as those a
| `/podcasts` | Podcasts. |
| `/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:
```
```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
@ -135,7 +136,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
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](https://en.wikipedia.org/wiki/Umask) 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`.
@ -144,21 +144,17 @@ Ensure any volume directories on the host are owned by the same user you specify
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
Default user/pass is admin/admin
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=booksonic&query=%24.mods%5B%27booksonic%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=booksonic "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/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: