You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
9
4
10
-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11
-
*[forum.linuxserver.io][forumurl]
12
-
*[IRC][ircurl] on freenode at `#linuxserver.io`
13
-
*[Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5
+
* regular and timely application updates
6
+
* easy user mappings (PGID, PUID)
7
+
* custom base image with s6 overlay
8
+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9
+
* regular security updates
14
10
15
-
# linuxserver/ubooquity
16
-
[](https://microbadger.com/images/linuxserver/ubooquity"Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/ubooquity"Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-ubooquity/)
11
+
Find us at:
12
+
*[Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13
+
*[IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14
+
*[Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15
+
*[Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
17
16
18
-
Ubooquity is 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.
17
+
# PSA: Changes are happening
18
+
19
+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20
+
21
+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
[](https://microbadger.com/images/linuxserver/ubooquity"Get your own version badge on microbadger.com")
26
+
[](https://microbadger.com/images/linuxserver/ubooquity"Get your own version badge on microbadger.com")
[Ubooquity](https://vaemendis.net/ubooquity/) is 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.
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).
39
+
40
+
Simply pulling `linuxserver/ubooquity` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Here are some example snippets to help you get started creating a container.
54
+
55
+
### docker
56
+
24
57
```
25
58
docker create \
26
59
--name=ubooquity \
60
+
-e PUID=1001 \
61
+
-e PGID=1001 \
62
+
-e TZ=Europe/London \
63
+
-e MAXMEM=<maxmem> \
64
+
-p 2202:2202 \
65
+
-p 2203:2203 \
27
66
-v <path to data>:/config \
28
67
-v <path to books>:/books \
29
68
-v <path to comics>:/comics \
30
69
-v <path to raw files>:/files \
31
-
-e MAXMEM=<maxmem> \
32
-
-e PGID=<gid> -e PUID=<uid> \
33
-
-p 2202:2202 \
34
-
-p 2203:2203 \
70
+
--restart unless-stopped \
35
71
linuxserver/ubooquity
36
72
```
37
73
38
-
## Parameters
39
-
40
-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
41
-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
42
-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
43
-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
44
-
45
74
75
+
### docker-compose
46
76
47
-
*`-p 2202` - the library port
48
-
*`-p 2203` - the admin port
49
-
*`-v /config` - Config files and database for ubooquity
50
-
*`-v /books` - Location of books.
51
-
*`-v /comics` - Location of comics.
52
-
*`-v /files` - Location of raw files.
53
-
*`-e MAXMEM` - to set the maximum memory
54
-
*`-e PGID` for GroupID - see below for explanation
55
-
*`-e PUID` for UserID - see below for explanation
77
+
Compatible with docker-compose v2 schemas.
56
78
57
-
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it ubooquity /bin/bash`.
79
+
```
80
+
---
81
+
version: "2"
82
+
services:
83
+
ubooquity:
84
+
image: linuxserver/ubooquity
85
+
container_name: ubooquity
86
+
environment:
87
+
- PUID=1001
88
+
- PGID=1001
89
+
- TZ=Europe/London
90
+
- MAXMEM=<maxmem>
91
+
volumes:
92
+
- <path to data>:/config
93
+
- <path to books>:/books
94
+
- <path to comics>:/comics
95
+
- <path to raw files>:/files
96
+
ports:
97
+
- 2202:2202
98
+
- 2203:2203
99
+
mem_limit: 4096m
100
+
restart: unless-stopped
101
+
```
58
102
59
-
### MAXMEM
103
+
##Parameters
60
104
61
-
The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get `java.lang.OutOfMemoryError:` Java heap space errors.
105
+
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.
62
106
63
-
You can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware).
107
+
| Parameter | Function |
108
+
| :----: | --- |
109
+
|`-p 2202`| The library port. |
110
+
|`-p 2203`| The admin port. |
111
+
|`-e PUID=1001`| for UserID - see below for explanation |
112
+
|`-e PGID=1001`| for GroupID - see below for explanation |
113
+
|`-e TZ=Europe/London`| Specify a timezone to use EG Europe/London. |
114
+
|`-e MAXMEM=<maxmem>`| To set the maximum memory. |
115
+
|`-v /config`| Config files and database for ubooquity. |
116
+
|`-v /books`| Location of books. |
117
+
|`-v /comics`| Location of comics. |
118
+
|`-v /files`| Location of raw files. |
64
119
65
-
If no value is set it will default to 512MB.
120
+
## User / Group Identifiers
66
121
67
-
### User / Group Identifiers
122
+
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`.
68
123
69
-
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" ™.
124
+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
70
125
71
-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
126
+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
Ubooquity has now been upgraded to [version 2](http://vaemendis.net/ubooquity/article19/ubooquity-2-1-0) and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below.
@@ -86,28 +143,53 @@ Then you can access the webui at `http://<your-ip>:2202/ubooquity/`
86
143
87
144
This container will automatically scan your files at startup.
88
145
89
-
##Info
146
+
### MAXMEM
90
147
91
-
* Shell access whilst the container is running: `docker exec -it ubooquity /bin/bash`
92
-
* To monitor the logs of the container in realtime: `docker logs -f ubooquity`
148
+
The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get `java.lang.OutOfMemoryError:` Java heap space errors.
93
149
94
-
* container version number
150
+
You can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware).
95
151
96
-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity`
152
+
If no value is set it will default to 512MB.
97
153
98
-
* image version number
99
154
100
-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity`
155
+
156
+
## Support Info
157
+
158
+
* Shell access whilst the container is running: `docker exec -it ubooquity /bin/bash`
159
+
* To monitor the logs of the container in realtime: `docker logs -f ubooquity`
160
+
* container version number
161
+
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity`
162
+
* image version number
163
+
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity`
164
+
165
+
## Updating Info
166
+
167
+
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
168
+
169
+
Below are the instructions for updating containers:
170
+
171
+
### Via Docker Run/Create
172
+
* Update the image: `docker pull linuxserver/ubooquity`
173
+
* Stop the running container: `docker stop ubooquity`
174
+
* Delete the container: `docker rm ubooquity`
175
+
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
176
+
* Start the new container: `docker start ubooquity`
177
+
* You can also remove the old dangling images: `docker image prune`
178
+
179
+
### Via Docker Compose
180
+
* Update the image: `docker-compose pull linuxserver/ubooquity`
181
+
* Let compose update containers as necessary: `docker-compose up -d`
182
+
* You can also remove the old dangling images: `docker image prune`
101
183
102
184
## Versions
103
185
104
-
+**28.01.19:** Add pipeline logic and multi arch.
105
-
+**15.10.18:** Upgrade to Ubooquity 2.1.2.
106
-
+**23.08.18:** Rebase to alpine 3.8.
107
-
+**09.12.17:** Rebase to alpine 3.7.
108
-
+**07.10.17:** Upgrade to Ubooquity 2.1.1.
109
-
+**16.07.17:** Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
110
-
+**26.05.17:** Rebase to alpine 3.6.
111
-
+**08.04.17:** Switch to java from 3.5 repo, fixes login crashes.
112
-
+**06.02.17:** Rebase to alpine 3.5.
113
-
+**06.12.16:** Initial Release.
186
+
***28.01.19:** - Add pipeline logic and multi arch.
187
+
***15.10.18:** - Upgrade to Ubooquity 2.1.2.
188
+
***23.08.18:** - Rebase to alpine 3.8.
189
+
***09.12.17:** - Rebase to alpine 3.7.
190
+
***07.10.17:** - Upgrade to Ubooquity 2.1.1.
191
+
***16.07.17:** - Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
192
+
***26.05.17:** - Rebase to alpine 3.6.
193
+
***08.04.17:** - Switch to java from 3.5 repo, fixes login crashes.
0 commit comments