You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
4.3 KiB
92 lines
4.3 KiB
[linuxserverurl]: https://linuxserver.io
|
|
[forumurl]: https://forum.linuxserver.io
|
|
[ircurl]: https://www.linuxserver.io/irc/
|
|
[podcasturl]: https://www.linuxserver.io/podcast/
|
|
|
|
[][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/ubooquity
|
|
[](https://microbadger.com/images/lsioarmhf/ubooquity "Get your own version badge on microbadger.com")[](http://microbadger.com/images/lsioarmhf/ubooquity "Get your own image badge on microbadger.com")[][hub][][hub][](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io-armhf/job/lsioarmhf-ubooquity/)
|
|
[hub]: https://hub.docker.com/r/linuxserver/ubooquity/
|
|
|
|
Tom, the author of [Ubooquity][ubooquityurl] has created a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer. He has also kindly agreed to let us publish this containerised version of Ubooquity.
|
|
|
|
[][ubooquityurl]
|
|
[ubooquityurl]: https://vaemendis.net/ubooquity/
|
|
|
|
## Usage
|
|
|
|
```
|
|
docker create \
|
|
--name=ubooquity \
|
|
-v <path to data>:/config \
|
|
-v <path to books>:/books \
|
|
-v <path to comics>:/comics \
|
|
-v <path to raw files>:/files \
|
|
-e PGID=<gid> -e PUID=<uid> \
|
|
-p 2202:2202 \
|
|
linuxserver/ubooquity
|
|
```
|
|
|
|
## 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 2202` - the port(s)
|
|
* `-v /config` - Config files and database for ubooquity
|
|
* `-v /books` - Location of books.
|
|
* `-v /comics` - Location of comics.
|
|
* `-v /files` - Location of raw files.
|
|
* `-e PGID` for GroupID - see below for explanation
|
|
* `-e PUID` for UserID - see below for explanation
|
|
|
|
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it ubooquity /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
|
|
|
|
This container will automatically scan your files at startup.
|
|
|
|
**IMPORTANT**
|
|
Access the admin page at `http://<your-ip>:2022/ubooquity/admin/` and set a password.
|
|
|
|
Then you can access the webui at `http://<your-ip>:2022/ubooquity/`
|
|
|
|
|
|
## Info
|
|
|
|
* Shell access whilst the container is running: `docker exec -it ubooquity /bin/bash`
|
|
* To monitor the logs of the container in realtime: `docker logs -f ubooquity`
|
|
|
|
* container version number
|
|
|
|
`docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity`
|
|
|
|
* image version number
|
|
|
|
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity`
|
|
|
|
## Versions
|
|
|
|
+ **06.12.16:** Initial Release.
|