diff --git a/images/docker-booksonic.md b/images/docker-booksonic.md index 1b173c59ba..7d3ca3745e 100644 --- a/images/docker-booksonic.md +++ b/images/docker-booksonic.md @@ -1,6 +1,12 @@ -# linuxserver/booksonic +# [linuxserver/booksonic](https://github.com/linuxserver/docker-booksonic) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-booksonic.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-booksonic/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/booksonic) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/booksonic) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/booksonic) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/booksonic) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-booksonic/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-booksonic/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/index.html) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-booksonic.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-booksonic/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/booksonic "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/booksonic "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/booksonic) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/booksonic.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/booksonic) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-booksonic/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-booksonic/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/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. @@ -13,18 +19,19 @@ Simply pulling `linuxserver/booksonic` should retrieve the correct image for you The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=booksonic \ -e PUID=1000 \ @@ -40,6 +47,7 @@ docker create \ linuxserver/booksonic ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,41 +76,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `4040` | Application WebUI | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `CONTEXT_PATH=url-base` | Base url for use with reverse proxies etc. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Configuration files. | | `/audiobooks` | Audiobooks. | | `/podcasts` | Podcasts. | | `/othermedia` | Other media. | + + ## 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`. +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: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -111,6 +122,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Default user/pass is admin/admin + ## Support Info * Shell access whilst the container is running: @@ -133,4 +145,3 @@ Default user/pass is admin/admin * **11.07.17:** - Rebase to alpine 3.6. * **07.02.17:** - Rebase to alpine 3.5. * **13.12.16:** - Initial Release. -