From 08ad04f6c24980000ca192c632fb7e0e7ddd0764 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:32:13 +0000 Subject: [PATCH 01/17] Update README.md --- README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 73 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3a8b3d2..df1da9b 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,80 @@ [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] -## This is a Container in active development by the [LinuxServer.io][linuxserverurl] team and is not recommended for use by the general public. - -If you want to comment\contribute on this container , are looking for support on any of our other work , or are curious about us in general, check out the following. - +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 + +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. + + +[![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-icon.png)][ubooquityurl] +[ubooquityurl]: https://vaemendis.net/ubooquity/ +Our Plex container has immaculate docs so follow that if in doubt for layout. + +`IMPORTANT, replace all instances of with the correct dockerhub repo (ie linuxserver/plex) and information (ie, plex)` + +## Usage + +``` +docker create \ + --name=uboquity \ + -v :/config \ + -v :/books \ + -v :/comics \ + -e PGID= -e PUID= \ + -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 1234` - the port(s) +* `-v /config` - explain what lives here +* `-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 /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 + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +## Setting up the application + +Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME + + +## 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:** Release From 45b006e82d4ee0672b81271c43b3a8e28386dbf9 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:38:44 +0000 Subject: [PATCH 02/17] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index df1da9b..1efb92f 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,6 @@ Ubooquity is a free, lightweight and easy-to-use home server for your comics and [![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-icon.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ -Our Plex container has immaculate docs so follow that if in doubt for layout. - -`IMPORTANT, replace all instances of with the correct dockerhub repo (ie linuxserver/plex) and information (ie, plex)` ## Usage @@ -27,8 +24,8 @@ Our Plex container has immaculate docs so follow that if in doubt for layout. docker create \ --name=uboquity \ -v :/config \ - -v :/books \ - -v :/comics \ + -v :/books:ro \ + -v :/comics:ro \ -e PGID= -e PUID= \ -p 2202:2202 \ linuxserver/ubooquity @@ -43,8 +40,10 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po -* `-p 1234` - the port(s) -* `-v /config` - explain what lives here +* `-p 2202` - the webui port +* `-v /config` - your ubooquity database and preferences +* `-v /books` - your ebook library +* `-v /comics` - your comic library * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation @@ -63,8 +62,9 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel ## Setting up the application -Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME +Access the admin page at `:2022/ubooquity/admin/` +Access WebUI at `:2022/ubooquity/` ## Info From dcfa70df4a7b9d068bc25714efb1801eb982549f Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:42:26 +0000 Subject: [PATCH 03/17] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1efb92f..dca7fde 100644 --- a/README.md +++ b/README.md @@ -62,9 +62,9 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel ## Setting up the application -Access the admin page at `:2022/ubooquity/admin/` +Access the admin page at `http://:2022/ubooquity/admin/` -Access WebUI at `:2022/ubooquity/` +Access WebUI at `http://:2022/ubooquity/` ## Info From 848adf7b19013bb8da45473e3396a8772b2eb979 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:51:15 +0000 Subject: [PATCH 04/17] Update README.md --- README.md | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index dca7fde..cc2df88 100644 --- a/README.md +++ b/README.md @@ -10,25 +10,27 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f * [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 +# lsioarmhf/ubooquity +[![](https://images.microbadger.com/badges/version/lsioarmhf/ubooquity.svg)](https://microbadger.com/images/lsioarmhf/ubooquity "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsioarmhf/ubooquity.svg)](http://microbadger.com/images/lsioarmhf/ubooquity "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsioarmhf/ubooquity.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsioarmhf/ubooquity.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io-armhf/lsioarmhf-ubooquity)](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io-armhf/job/lsioarmhf-ubooquity/) +[hub]: https://hub.docker.com/r/lsioarmhf/ubooquity/ -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. +[Ubooquity][ubooquityurl] 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. - -[![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-icon.png)][ubooquityurl] +[![ubooquity](https://vaemendis.net/ubooquity/data/images/diagram2.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ ## Usage ``` docker create \ - --name=uboquity \ + --name=ubooquity \ -v :/config \ - -v :/books:ro \ - -v :/comics:ro \ + -v :/books \ + -v :/comics \ + -v :/files \ -e PGID= -e PUID= \ -p 2202:2202 \ - linuxserver/ubooquity + lsioarmhf/ubooquity ``` ## Parameters @@ -40,14 +42,15 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po -* `-p 2202` - the webui port -* `-v /config` - your ubooquity database and preferences -* `-v /books` - your ebook library -* `-v /comics` - your comic library +* `-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 /bin/bash`. +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 @@ -61,10 +64,15 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel ``` ## Setting up the application +`IMPORTANT... THIS IS THE ARMHF VERSION` + +This container will automatically scan your files at startup. + +**IMPORTANT** +Access the admin page at `http://:2022/ubooquity/admin/` and set a password. -Access the admin page at `http://:2022/ubooquity/admin/` +Then you can access the webui at `http://:2022/ubooquity/` -Access WebUI at `http://:2022/ubooquity/` ## Info @@ -77,8 +85,8 @@ Access WebUI at `http://:2022/ubooquity/` * image version number -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity` +`docker inspect -f '{{ index .Config.Labels "build_version" }}' lsioarmhf/ubooquity` ## Versions -+ **06.12.16:** Release ++ **dd.MM.yy:** Initial Release. From c88c1bd31946a1aad9de592c68dacc22bf167c83 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:51:53 +0000 Subject: [PATCH 05/17] Delete READMETEMPLATE.md --- READMETEMPLATE.md | 79 ----------------------------------------------- 1 file changed, 79 deletions(-) delete mode 100644 READMETEMPLATE.md diff --git a/READMETEMPLATE.md b/READMETEMPLATE.md deleted file mode 100644 index d800e5d..0000000 --- a/READMETEMPLATE.md +++ /dev/null @@ -1,79 +0,0 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ - -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][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! - -# - -Provide a short, concise description of the application. No more than two SHORT paragraphs. Link to sources where possible and include an image illustrating your point if necessary. Point users to the original applications website, as that's the best place to get support - not here. - -Our Plex container has immaculate docs so follow that if in doubt for layout. - -`IMPORTANT, replace all instances of with the correct dockerhub repo (ie linuxserver/plex) and information (ie, plex)` - -## Usage - -``` -docker create \ - --name= \ - -v :/config \ - -e PGID= -e PUID= \ - -p 1234:1234 \ - -``` - -## 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 1234` - the port(s) -* `-v /config` - explain what lives here -* `-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 /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 - uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) -``` - -## Setting up the application - -Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME - - -## Info - -* Shell access whilst the container is running: `docker exec -it /bin/bash` -* To monitor the logs of the container in realtime: `docker logs -f ` - -* container version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' ` - -* image version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' ` - -## Versions - -+ **dd.MM.yy:** This is the standard Version type now. From a39fb1722b0310d6f516257c1e83b5d52ce96bc3 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:55:31 +0000 Subject: [PATCH 06/17] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cc2df88..0c47801 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f * [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! -# lsioarmhf/ubooquity +# linuxserver/ubooquity [![](https://images.microbadger.com/badges/version/lsioarmhf/ubooquity.svg)](https://microbadger.com/images/lsioarmhf/ubooquity "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsioarmhf/ubooquity.svg)](http://microbadger.com/images/lsioarmhf/ubooquity "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsioarmhf/ubooquity.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsioarmhf/ubooquity.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io-armhf/lsioarmhf-ubooquity)](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io-armhf/job/lsioarmhf-ubooquity/) -[hub]: https://hub.docker.com/r/lsioarmhf/ubooquity/ +[hub]: https://hub.docker.com/r/linuxserver/ubooquity/ [Ubooquity][ubooquityurl] 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. @@ -30,7 +30,7 @@ docker create \ -v :/files \ -e PGID= -e PUID= \ -p 2202:2202 \ - lsioarmhf/ubooquity + linuxserver/ubooquity ``` ## Parameters @@ -64,7 +64,6 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel ``` ## Setting up the application -`IMPORTANT... THIS IS THE ARMHF VERSION` This container will automatically scan your files at startup. @@ -85,7 +84,7 @@ Then you can access the webui at `http://:2022/ubooquity/` * image version number -`docker inspect -f '{{ index .Config.Labels "build_version" }}' lsioarmhf/ubooquity` +`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity` ## Versions From a018eb65fd39b37be9e133e278f41e78421d0f4f Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 6 Dec 2016 16:56:03 +0000 Subject: [PATCH 07/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c47801..d7d4ae0 100644 --- a/README.md +++ b/README.md @@ -88,4 +88,4 @@ Then you can access the webui at `http://:2022/ubooquity/` ## Versions -+ **dd.MM.yy:** Initial Release. ++ **06.12.16:** Initial Release. From 92b856974bd7eba3fd514c568adb62bf1305671e Mon Sep 17 00:00:00 2001 From: CHBMB Date: Thu, 8 Dec 2016 11:22:51 +0000 Subject: [PATCH 08/17] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d7d4ae0..12cdda8 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f [![](https://images.microbadger.com/badges/version/lsioarmhf/ubooquity.svg)](https://microbadger.com/images/lsioarmhf/ubooquity "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsioarmhf/ubooquity.svg)](http://microbadger.com/images/lsioarmhf/ubooquity "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsioarmhf/ubooquity.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsioarmhf/ubooquity.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io-armhf/lsioarmhf-ubooquity)](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io-armhf/job/lsioarmhf-ubooquity/) [hub]: https://hub.docker.com/r/linuxserver/ubooquity/ -[Ubooquity][ubooquityurl] 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. +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. -[![ubooquity](https://vaemendis.net/ubooquity/data/images/diagram2.png)][ubooquityurl] +[![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-icon.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ ## Usage From 2d8b06d6ed5f99a3e231f25fc22da052c67611fa Mon Sep 17 00:00:00 2001 From: CHBMB Date: Thu, 8 Dec 2016 11:26:53 +0000 Subject: [PATCH 09/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 12cdda8..56e7207 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f 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. -[![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-icon.png)][ubooquityurl] +[![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-banner.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ ## Usage From bfda020c9e99c661b605cfb889c5fc4d25e7c524 Mon Sep 17 00:00:00 2001 From: CHBMB Date: Thu, 8 Dec 2016 11:31:11 +0000 Subject: [PATCH 10/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56e7207..50a65be 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f 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. -[![ubooquity](https://raw.githubusercontent.com/chbmb/docker-templates/master/linuxserver.io/img/ubooquity-banner.png)][ubooquityurl] +[![ubooquity](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ubooquity-banner.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ ## Usage From 646d55c456de1088639bbcc2714c6775a3dba177 Mon Sep 17 00:00:00 2001 From: CHBMB Date: Thu, 8 Dec 2016 11:33:09 +0000 Subject: [PATCH 11/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 50a65be..6fd9acb 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f [![](https://images.microbadger.com/badges/version/lsioarmhf/ubooquity.svg)](https://microbadger.com/images/lsioarmhf/ubooquity "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsioarmhf/ubooquity.svg)](http://microbadger.com/images/lsioarmhf/ubooquity "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsioarmhf/ubooquity.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsioarmhf/ubooquity.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io-armhf/lsioarmhf-ubooquity)](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. +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 kindly permitted us to publish this docker container version of Ubooquity. [![ubooquity](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ubooquity-banner.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ From 7212cff3bd6bdcc89383061e5177f96b50f9be7b Mon Sep 17 00:00:00 2001 From: Neil Date: Thu, 8 Dec 2016 20:54:37 +0000 Subject: [PATCH 12/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fd9acb..1edb924 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f [![](https://images.microbadger.com/badges/version/lsioarmhf/ubooquity.svg)](https://microbadger.com/images/lsioarmhf/ubooquity "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsioarmhf/ubooquity.svg)](http://microbadger.com/images/lsioarmhf/ubooquity "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsioarmhf/ubooquity.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsioarmhf/ubooquity.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io-armhf/lsioarmhf-ubooquity)](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 kindly permitted us to publish this docker container version of Ubooquity. +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. [![ubooquity](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ubooquity-banner.png)][ubooquityurl] [ubooquityurl]: https://vaemendis.net/ubooquity/ From e319da05cf7ca543bf3c169e1e88e99f07c493a2 Mon Sep 17 00:00:00 2001 From: Neil Date: Thu, 8 Dec 2016 22:00:30 +0000 Subject: [PATCH 13/17] Try limiting java memory --- root/etc/services.d/ubooquity/run | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/root/etc/services.d/ubooquity/run b/root/etc/services.d/ubooquity/run index b032539..b05766d 100644 --- a/root/etc/services.d/ubooquity/run +++ b/root/etc/services.d/ubooquity/run @@ -3,7 +3,7 @@ cd /opt/ubooquity || exit exec \ - s6-setuidgid abc java \ + s6-setuidgid abc java -Xmx512m\ -jar /opt/ubooquity/Ubooquity.jar \ --headless --host 0.0.0.0 \ --port 2202 --webadmin \ From ebfb90728724cbef1a1c66fddc1e5d4d03143631 Mon Sep 17 00:00:00 2001 From: Neil Date: Thu, 8 Dec 2016 22:30:09 +0000 Subject: [PATCH 14/17] Update run --- root/etc/services.d/ubooquity/run | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/root/etc/services.d/ubooquity/run b/root/etc/services.d/ubooquity/run index b05766d..fdad029 100644 --- a/root/etc/services.d/ubooquity/run +++ b/root/etc/services.d/ubooquity/run @@ -1,9 +1,18 @@ #!/usr/bin/with-contenv bash +if [ -e "$MAXMEM" ] + then + JAVAMEM="$MAXMEM" + else + JAVAMEM="512" +fi + +JAVAMEM=${MAXMEM:-512} + cd /opt/ubooquity || exit exec \ - s6-setuidgid abc java -Xmx512m\ + s6-setuidgid abc java -Xmx"$JAVAMEM"m\ -jar /opt/ubooquity/Ubooquity.jar \ --headless --host 0.0.0.0 \ --port 2202 --webadmin \ From e0fe915b96d6ac7bd2cdf397c6ba67461deb6aa5 Mon Sep 17 00:00:00 2001 From: Neil Date: Thu, 8 Dec 2016 23:06:28 +0000 Subject: [PATCH 15/17] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1edb924..52c5d3d 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ docker create \ -v :/books \ -v :/comics \ -v :/files \ + -e MAXMEM= \ -e PGID= -e PUID= \ -p 2202:2202 \ linuxserver/ubooquity @@ -47,11 +48,20 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po * `-v /books` - Location of books. * `-v /comics` - Location of comics. * `-v /files` - Location of raw files. +* `-e MAXMEM` - to set the maximum memory * `-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`. +###MAXMEM + +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. + +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). + +If no value is set it will default to 512MB. + ### 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" ™. From ad32bdf208d34f7a63cdfb4c619e5b16f60f19e0 Mon Sep 17 00:00:00 2001 From: Neil Date: Fri, 9 Dec 2016 00:56:51 +0000 Subject: [PATCH 16/17] Update run --- root/etc/services.d/ubooquity/run | 7 ------- 1 file changed, 7 deletions(-) diff --git a/root/etc/services.d/ubooquity/run b/root/etc/services.d/ubooquity/run index fdad029..db6e69d 100644 --- a/root/etc/services.d/ubooquity/run +++ b/root/etc/services.d/ubooquity/run @@ -1,12 +1,5 @@ #!/usr/bin/with-contenv bash -if [ -e "$MAXMEM" ] - then - JAVAMEM="$MAXMEM" - else - JAVAMEM="512" -fi - JAVAMEM=${MAXMEM:-512} cd /opt/ubooquity || exit From d043d7891e700384e167dee35151877a430a76c0 Mon Sep 17 00:00:00 2001 From: Neil Date: Fri, 9 Dec 2016 00:59:15 +0000 Subject: [PATCH 17/17] Update run --- root/etc/services.d/ubooquity/run | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/root/etc/services.d/ubooquity/run b/root/etc/services.d/ubooquity/run index db6e69d..fb65107 100644 --- a/root/etc/services.d/ubooquity/run +++ b/root/etc/services.d/ubooquity/run @@ -5,7 +5,7 @@ JAVAMEM=${MAXMEM:-512} cd /opt/ubooquity || exit exec \ - s6-setuidgid abc java -Xmx"$JAVAMEM"m\ + s6-setuidgid abc java -Xmx"$JAVAMEM"m \ -jar /opt/ubooquity/Ubooquity.jar \ --headless --host 0.0.0.0 \ --port 2202 --webadmin \