From 5daa556c9b1b8eeb46436a51f1c459ecdba0edb5 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 12 Feb 2019 14:33:13 +0000 Subject: [PATCH] Bot Updating Templated Files --- images/docker-booksonic.md | 173 ++++++++++++++++++++++++------------- 1 file changed, 111 insertions(+), 62 deletions(-) diff --git a/images/docker-booksonic.md b/images/docker-booksonic.md index ea7cbbf379..bfa7935daf 100755 --- a/images/docker-booksonic.md +++ b/images/docker-booksonic.md @@ -1,97 +1,146 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: http://booksonic.org -[hub]: https://hub.docker.com/r/linuxserver/booksonic/ +# [linuxserver/booksonic](https://github.com/linuxserver/docker-booksonic) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/booksonic.svg)](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) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/booksonic.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-booksonic/master)](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) -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! +[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. -# linuxserver/booksonic -[![](https://images.microbadger.com/badges/version/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/booksonic.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/booksonic.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-booksonic)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-booksonic/) +## Supported Architectures -[Booksonic][appurl] 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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list). + +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 | arm32v6-latest | -[![booksonic](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/booksonic.png)][appurl] ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### docker + ``` docker create \ --name=booksonic \ --v :/config \ --v :/books \ --v :/podcasts \ --v :/media \ --e PGID= -e PUID= \ --e CONTEXT_PATH= \ --e TZ= \ --p 4040:4040 \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -e CONTEXT_PATH=url-base \ + -p 4040:4040 \ + -v :/config \ + -v :/audiobooks \ + -v :/podcasts \ + -v :/othermedia \ + --restart unless-stopped \ linuxserver/booksonic ``` + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + booksonic: + image: linuxserver/booksonic + container_name: booksonic + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + - CONTEXT_PATH=url-base + volumes: + - :/config + - :/audiobooks + - :/podcasts + - :/othermedia + ports: + - 4040:4040 + mem_limit: 4096m + restart: unless-stopped +``` + ## Parameters -`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +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`) + +| Parameter | Function | +| :----: | --- | +| `4040` | Application WebUI | + + +### Environment Variables (`-e`) + +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | 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 | Function | +| :----: | --- | +| `/config` | Configuration files. | +| `/audiobooks` | Audiobooks. | +| `/podcasts` | Podcasts. | +| `/othermedia` | Other media. | -* `-p 4040` - the port(s) -* `-v /config` - Configuration file location -* `-v /books` - Location of audiobooks. -* `-v /podcasts` - Location of podcasts. -* `-v /media` - Location of other media - *optional* -* `-e PGID` for for GroupID - see below for explanation - *optional* -* `-e PUID` for for UserID - see below for explanation - *optional* -* `-e CONTEXT_PATH` for setting url-base in reverse proxy setups - *optional* -* `-e TZ` for setting timezone information, eg Europe/London +## User / Group Identifiers -It is based on ubuntu bionic with s6 overlay, for shell access whilst the container is running do `docker exec -it booksonic /bin/bash`. +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`. -### User / Group Identifiers +Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. -Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. - -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: +In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below: ``` - $ id + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application - -Access WebUI at `:4040`. +## Application Setup Default user/pass is admin/admin -## 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` +## Support Info -* 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` +* 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` ## Versions -+ **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. +* **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.