kopia lustrzana https://github.com/linuxserver/docker-documentation
GitBook: [master] 24 pages modified
Josh Stark
gitbook-bot
rodzic
7265b96cca
commit
054c439a47
29
SUMMARY.md
29
SUMMARY.md
|
|
@ -1,16 +1,21 @@
|
|||
# Table of contents
|
||||
|
||||
* [Introduction](README.md)
|
||||
* [General](general/README.md)
|
||||
* [Container Execution](general/container-execution.md)
|
||||
* [Docker Containers: 101](general/containers-101.md)
|
||||
* [Docker Compose](general/docker-compose.md)
|
||||
* [Running LinuxServer Containers](general/running-our-containers.md)
|
||||
* [Understanding PUID and PGID](general/understanding-puid-and-pgid.md)
|
||||
* [Updating our containers](general/updating-our-containers.md)
|
||||
* [Volumes](general/volumes.md)
|
||||
* [Images](images/README.md)
|
||||
* [linuxserver/bookstack](images/docker-bookstack.md)
|
||||
* [linuxserver/headphones](images/docker-headphones.md)
|
||||
* [linuxserver/lazylibrarian](images/docker-lazylibrarian.md)
|
||||
|
||||
## Image Documentation
|
||||
|
||||
* [Images](image-documentation/images/README.md)
|
||||
* [linuxserver/bookstack](image-documentation/images/docker-bookstack.md)
|
||||
* [linuxserver/headphones](image-documentation/images/docker-headphones.md)
|
||||
* [linuxserver/lazylibrarian](image-documentation/images/docker-lazylibrarian.md)
|
||||
|
||||
## General
|
||||
|
||||
* [Container Execution](general-1/container-execution.md)
|
||||
* [Docker Containers: 101](general-1/containers-101.md)
|
||||
* [Running LinuxServer Containers](general-1/running-our-containers.md)
|
||||
* [Docker Compose](general-1/docker-compose.md)
|
||||
* [Understanding PUID and PGID](general-1/understanding-puid-and-pgid.md)
|
||||
* [Updating our containers](general-1/updating-our-containers.md)
|
||||
* [Volumes](general-1/volumes.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
# General
|
||||
|
||||
As well as usage documentation for each of our images, we also provide general information regarding Docker, and how to best make use of our fleet of images when you run them up as containers.
|
||||
|
||||
|
|
@ -1,24 +1,21 @@
|
|||
# [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
# linuxserver/bookstack
|
||||
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/bookstack) [](https://microbadger.com/images/linuxserver/bookstack)  
|
||||
|
||||
[Bookstack](https://github.com/BookStackApp/BookStack) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
|
||||
|
||||
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
|
||||
|
||||
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
|
||||
For more information on BookStack visit their website and check it out: [https://www.bookstackapp.com](https://www.bookstackapp.com)
|
||||
|
||||
## 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).
|
||||
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).
|
||||
|
||||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
|
@ -29,7 +26,7 @@ Here are some example snippets to help you get started creating a container.
|
|||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=bookstack \
|
||||
-e PUID=1001 \
|
||||
|
|
@ -45,12 +42,11 @@ docker create \
|
|||
linuxserver/bookstack
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```
|
||||
```text
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
|
|
@ -75,41 +71,41 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Port | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `80` | will map the container's port 80 to port 6875 on the host |
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1001` | for UserID - see below for explanation |
|
||||
| `PGID=1001` | for GroupID - see below for explanation |
|
||||
| `DB_HOST=<yourdbhost>` | for specifying the database host |
|
||||
| `DB_USER=<yourdbuser>` | for specifying the database user |
|
||||
| `DB_PASS=<yourdbpass>` | for specifying the database password |
|
||||
| `DB_DATABASE=bookstackapp` | for specifying the database to be used |
|
||||
| `APPURL=your.site.here.xyz` | for specifying the url your application will be accessed on |
|
||||
| `APPURL=your.site.here.xyz` | for specifying the url your application will be accessed on |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | this will store any uploaded data on the docker host |
|
||||
|
||||
## 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=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
|
@ -133,24 +129,25 @@ GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@%;
|
|||
FLUSH PRIVILEGES;
|
||||
```
|
||||
|
||||
Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as <yourdbuser> with the correct data.
|
||||
Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as with the correct data.
|
||||
|
||||
Then docker start bookstackapp to start the container. You should then be able to access the container at http://dockerhost:6875
|
||||
Then docker start bookstackapp to start the container. You should then be able to access the container at [http://dockerhost:6875](http://dockerhost:6875)
|
||||
|
||||
Default username is admin@admin.com with password of **password**
|
||||
|
||||
If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APPURL` environment variable is set, or it will not work
|
||||
|
||||
Documentation can be found at https://www.bookstackapp.com/docs/
|
||||
Documentation can be found at [https://www.bookstackapp.com/docs/](https://www.bookstackapp.com/docs/)
|
||||
|
||||
### Advanced Users
|
||||
|
||||
If you wish to use the extra functionality of BookStack such as email, memcache, ldap and so on you will need to make your own .env file with guidance from the BookStack documentation.
|
||||
|
||||
When you create the container, do not set any arguements for SQL or APPURL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
|
||||
When you create the container, do not set any arguements for SQL or APPURL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
|
||||
|
||||
### Composer
|
||||
|
||||
Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you.
|
||||
Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -169,3 +166,4 @@ Some simple docker-compose files are included for you to get started with. You w
|
|||
* **08.10.18:** - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
|
||||
* **23.09.28:** - Updates pre-release
|
||||
* **02.07.18:** - Initial Release.
|
||||
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
# linuxserver/headphones
|
||||
|
||||
[](https://linuxserver.io)
|
||||
|
||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
||||
|
||||
* [forum.linuxserver.io](https://forum.linuxserver.io)
|
||||
* [IRC](https://www.linuxserver.io/irc/) on freenode at `#linuxserver.io`
|
||||
* [Podcast](https://www.linuxserver.io/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
||||
|
||||
## linuxserver/headphones
|
||||
|
||||
[](https://microbadger.com/images/linuxserver/headphones)[](https://microbadger.com/images/linuxserver/headphones)[](https://hub.docker.com/r/linuxserver/headphones/)[](https://hub.docker.com/r/linuxserver/headphones/)[](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-headphones/)
|
||||
|
||||
[headphones](https://hub.docker.com/r/linuxserver/headphones/) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.
|
||||
|
||||
[](https://github.com/rembo10/headphones)
|
||||
|
||||
### Usage
|
||||
|
||||
```text
|
||||
docker create \
|
||||
--name="headphones" \
|
||||
-v /path/to/headphones/data:/config \
|
||||
-v /path/to/downloads:/downloads \
|
||||
-v /path/to/music:/music \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 8181:8181 \
|
||||
linuxserver/headphones
|
||||
```
|
||||
|
||||
### 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.`
|
||||
|
||||
* `-p 8181` - the port\(s\)
|
||||
* `-v /config` - Configuration file location
|
||||
* `-v /music` - Location of music. \(i.e. /opt/downloads/music or /var/music\)
|
||||
* `-v /downloads` - Location of downloads folder
|
||||
* `-e PGID` for for GroupID - see below for explanation - _optional_
|
||||
* `-e PUID` for for UserID - see below for explanation - _optional_
|
||||
* `-e TZ` for setting timezone information, eg Europe/London
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it headphones /bin/bash`.
|
||||
|
||||
#### User / Group Identifiers
|
||||
|
||||
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:
|
||||
|
||||
```text
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
### Setting up the application
|
||||
|
||||
Access WebUI at `<your-ip>:8181` and walk through the wizard.
|
||||
|
||||
### Info
|
||||
|
||||
* To monitor the logs of the container in realtime `docker logs -f headphones`.
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/headphones`
|
||||
|
||||
### Versions
|
||||
|
||||
* **16.01.19:** Add pipeline logic and multi arch.
|
||||
* **18.08.18:** Rebase to alpine 3.8.
|
||||
* **03.04.18:** Remove forced port and update README.
|
||||
* **05.01.18:** Deprecate cpu\_core routine lack of scaling.
|
||||
* **12.12.17:** Rebase to alpine 3.7.
|
||||
* **20.07.17:** Internal git pull instead of at runtime.
|
||||
* **12.07.17:** Add inspect commands to README, move to jenkins build and push.
|
||||
* **28.05.17:** Add flac package to handle FLAC based .cue.
|
||||
* **25.05.17:** Rebase to alpine 3.6.
|
||||
* **03.05.17:** Reduce layer, replace broken source for shntool.
|
||||
* **07.02.17:** Rebase to alpine 3.5.
|
||||
* **23.12.16:** Fix capitalisation in README.
|
||||
* **09.09.16:** Add layer badges to README.
|
||||
* **27.08.16:** Add badges to README, compile shntool.
|
||||
* **08.08.16:** Rebase to alpine linux.
|
||||
* **18.07.15:** Inital Release
|
||||
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
# linuxserver/lazylibrarian
|
||||
|
||||
[](https://linuxserver.io)
|
||||
|
||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
||||
|
||||
* [forum.linuxserver.io](https://forum.linuxserver.io)
|
||||
* [IRC](https://www.linuxserver.io/irc/) on freenode at `#linuxserver.io`
|
||||
* [Podcast](https://www.linuxserver.io/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
||||
|
||||
## linuxserver/lazylibrarian
|
||||
|
||||
[](https://microbadger.com/images/linuxserver/lazylibrarian)[](https://microbadger.com/images/linuxserver/lazylibrarian)[](https://hub.docker.com/r/linuxserver/lazylibrarian/)[](https://hub.docker.com/r/linuxserver/lazylibrarian/)[](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-lazylibrarian/)
|
||||
|
||||
[LazyLibrarian](https://github.com/DobyTang/LazyLibrarian) is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
|
||||
|
||||
[](https://github.com/DobyTang/LazyLibrarian)
|
||||
|
||||
### Usage
|
||||
|
||||
```text
|
||||
docker create \
|
||||
--name=lazylibrarian \
|
||||
-v <path to data>:/config \
|
||||
-v <path to data>:/downloads \
|
||||
-v <path to data>:/books \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 5299:5299 \
|
||||
linuxserver/lazylibrarian
|
||||
```
|
||||
|
||||
### 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.`
|
||||
|
||||
* `-p 5299` - Port for webui
|
||||
* `-v /config` Containers lazylibrarian config and database
|
||||
* `-v /downloads` lazylibrarian download folder
|
||||
* `-v /books` location of ebook library
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
* `-e TZ` for setting timezone information, eg Europe/London
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it lazylibrarian /bin/bash`.
|
||||
|
||||
#### User / Group Identifiers
|
||||
|
||||
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:
|
||||
|
||||
```text
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
### Setting up the application
|
||||
|
||||
Access the webui at `<your-ip>:5299/home`, for more information check out [LazyLibrarian](https://github.com/DobyTang/LazyLibrarian)..
|
||||
|
||||
### Info
|
||||
|
||||
* To monitor the logs of the container in realtime `docker logs -f lazylibrarian`.
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' lazylibrarian`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lazylibrarian`
|
||||
|
||||
### Versions
|
||||
|
||||
* **10.12.18:** Moved to Pipeline Building
|
||||
* **16.08.18:** Rebase to alpine 3.8.
|
||||
* **05.01.18:** Deprecate cpu\_core routine lack of scaling.
|
||||
* **12.12.17:** Rebase to alpine 3.7.
|
||||
* **21.07.17:** Internal git pull instead of at runtime.
|
||||
* **25.05.17:** Rebase to alpine 3.6.
|
||||
* **07.02.17:** Rebase to alpine 3.5.
|
||||
* **30.01.17:** Compile libunrar.so to allow reading of .cbr format files.
|
||||
* **12.01.17:** Add ghostscript package, allows magazine covers to be created etc.
|
||||
* **14.10.16:** Add version layer information.
|
||||
* **03.10.16:** Fix non-persistent settings and make log folder.
|
||||
* **28.09.16:** Inital Release.
|
||||
|
||||
|
|
@ -1,98 +0,0 @@
|
|||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://github.com/rembo10/headphones
|
||||
[hub]: https://hub.docker.com/r/linuxserver/headphones/
|
||||
|
||||
[][linuxserverurl]
|
||||
|
||||
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!
|
||||
|
||||
# linuxserver/headphones
|
||||
[](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/headphones "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-headphones/)
|
||||
|
||||
[headphones](https://hub.docker.com/r/linuxserver/headphones/) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name="headphones" \
|
||||
-v /path/to/headphones/data:/config \
|
||||
-v /path/to/downloads:/downloads \
|
||||
-v /path/to/music:/music \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 8181:8181 \
|
||||
linuxserver/headphones
|
||||
```
|
||||
|
||||
## 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.`
|
||||
|
||||
|
||||
* `-p 8181` - the port(s)
|
||||
* `-v /config` - Configuration file location
|
||||
* `-v /music` - Location of music. (i.e. /opt/downloads/music or /var/music)
|
||||
* `-v /downloads` - Location of downloads folder
|
||||
* `-e PGID` for for GroupID - see below for explanation - *optional*
|
||||
* `-e PUID` for for UserID - see below for explanation - *optional*
|
||||
* `-e TZ` for setting timezone information, eg Europe/London
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it headphones /bin/bash`.
|
||||
|
||||
### User / Group Identifiers
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
|
||||
Access WebUI at `<your-ip>:8181` and walk through the wizard.
|
||||
|
||||
## Info
|
||||
|
||||
* To monitor the logs of the container in realtime `docker logs -f headphones`.
|
||||
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/headphones`
|
||||
|
||||
## Versions
|
||||
|
||||
+ **16.01.19:** Add pipeline logic and multi arch.
|
||||
+ **18.08.18:** Rebase to alpine 3.8.
|
||||
+ **03.04.18:** Remove forced port and update README.
|
||||
+ **05.01.18:** Deprecate cpu_core routine lack of scaling.
|
||||
+ **12.12.17:** Rebase to alpine 3.7.
|
||||
+ **20.07.17:** Internal git pull instead of at runtime.
|
||||
+ **12.07.17:** Add inspect commands to README, move to jenkins build and push.
|
||||
+ **28.05.17:** Add flac package to handle FLAC based .cue.
|
||||
+ **25.05.17:** Rebase to alpine 3.6.
|
||||
+ **03.05.17:** Reduce layer, replace broken source for shntool.
|
||||
+ **07.02.17:** Rebase to alpine 3.5.
|
||||
+ **23.12.16:** Fix capitalisation in README.
|
||||
+ **09.09.16:** Add layer badges to README.
|
||||
+ **27.08.16:** Add badges to README, compile shntool.
|
||||
+ **08.08.16:** Rebase to alpine linux.
|
||||
+ **18.07.15:** Inital Release
|
||||
|
|
@ -1,93 +0,0 @@
|
|||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://github.com/DobyTang/LazyLibrarian
|
||||
[hub]: https://hub.docker.com/r/linuxserver/lazylibrarian/
|
||||
|
||||
[][linuxserverurl]
|
||||
|
||||
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!
|
||||
|
||||
# linuxserver/lazylibrarian
|
||||
[](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-lazylibrarian/)
|
||||
|
||||
[LazyLibrarian][appurl] is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=lazylibrarian \
|
||||
-v <path to data>:/config \
|
||||
-v <path to data>:/downloads \
|
||||
-v <path to data>:/books \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 5299:5299 \
|
||||
linuxserver/lazylibrarian
|
||||
```
|
||||
|
||||
## 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.`
|
||||
|
||||
|
||||
* `-p 5299` - Port for webui
|
||||
* `-v /config` Containers lazylibrarian config and database
|
||||
* `-v /downloads` lazylibrarian download folder
|
||||
* `-v /books` location of ebook library
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
* `-e TZ` for setting timezone information, eg Europe/London
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it lazylibrarian /bin/bash`.
|
||||
|
||||
### User / Group Identifiers
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
Access the webui at `<your-ip>:5299/home`, for more information check out [LazyLibrarian][appurl]..
|
||||
|
||||
## Info
|
||||
|
||||
* To monitor the logs of the container in realtime `docker logs -f lazylibrarian`.
|
||||
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' lazylibrarian`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lazylibrarian`
|
||||
|
||||
## Versions
|
||||
|
||||
+ **10.12.18:** Moved to Pipeline Building
|
||||
+ **16.08.18:** Rebase to alpine 3.8.
|
||||
+ **05.01.18:** Deprecate cpu_core routine lack of scaling.
|
||||
+ **12.12.17:** Rebase to alpine 3.7.
|
||||
+ **21.07.17:** Internal git pull instead of at runtime.
|
||||
+ **25.05.17:** Rebase to alpine 3.6.
|
||||
+ **07.02.17:** Rebase to alpine 3.5.
|
||||
+ **30.01.17:** Compile libunrar.so to allow reading of .cbr format files.
|
||||
+ **12.01.17:** Add ghostscript package, allows magazine covers to be created etc.
|
||||
+ **14.10.16:** Add version layer information.
|
||||
+ **03.10.16:** Fix non-persistent settings and make log folder.
|
||||
+ **28.09.16:** Inital Release.
|
||||
Ładowanie…
Reference in New Issue