From e0fe915b96d6ac7bd2cdf397c6ba67461deb6aa5 Mon Sep 17 00:00:00 2001 From: Neil Date: Thu, 8 Dec 2016 23:06:28 +0000 Subject: [PATCH] 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" ™.