kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
a503edcb6d
commit
c851201533
|
|
@ -1,6 +1,14 @@
|
|||
# linuxserver/ubooquity
|
||||
# [linuxserver/ubooquity](https://github.com/linuxserver/docker-ubooquity)
|
||||
|
||||
[](https://github.com/linuxserver/docker-ubooquity) [](https://github.com/linuxserver/docker-ubooquity/releases) [](https://github.com/linuxserver/docker-ubooquity/packages) [](https://gitlab.com/Linuxserver.io/docker-ubooquity/container_registry) [](https://microbadger.com/images/linuxserver/ubooquity) [](https://hub.docker.com/r/linuxserver/ubooquity) [](https://hub.docker.com/r/linuxserver/ubooquity) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ubooquity/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ubooquity/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-ubooquity)
|
||||
[](https://github.com/linuxserver/docker-ubooquity/releases)
|
||||
[](https://github.com/linuxserver/docker-ubooquity/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-ubooquity/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/ubooquity)
|
||||
[](https://hub.docker.com/r/linuxserver/ubooquity)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ubooquity/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ubooquity/latest/index.html)
|
||||
|
||||
[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.
|
||||
|
||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/ubooquity` should retrieve the correct image for you
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=ubooquity \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -41,6 +50,7 @@ docker create \
|
|||
linuxserver/ubooquity
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -70,40 +80,43 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker 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.
|
||||
Docker 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`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `2202` | The library port. |
|
||||
| `2203` | The admin port. |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `MAXMEM=<maxmem>` | To set the maximum memory. \( ex: set '1024' for 1GB \) |
|
||||
| `MAXMEM=<maxmem>` | To set the maximum memory. ( ex: set '1024' for 1GB ) |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Config files and database for ubooquity. |
|
||||
| `/books` | Location of books. |
|
||||
| `/comics` | Location of comics. |
|
||||
| `/files` | Location of raw files. |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -111,24 +124,27 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
||||
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
|
||||
|
||||
## 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=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
**IMPORTANT** 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.
|
||||
**IMPORTANT**
|
||||
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.
|
||||
|
||||
Access the admin page at `http://<your-ip>:2203/ubooquity/admin` and set a password.
|
||||
|
||||
|
|
@ -140,15 +156,16 @@ This container will automatically scan your files at startup.
|
|||
|
||||
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\). Value is a number of megabytes \( put just a number, without MB \)
|
||||
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). Value is a number of megabytes ( put just a number, without MB )
|
||||
|
||||
If no value is set it will default to 512MB.
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=ubooquity "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=ubooquity)
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -177,4 +194,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **08.04.17:** - Switch to java from 3.5 repo, fixes login crashes.
|
||||
* **06.02.17:** - Rebase to alpine 3.5.
|
||||
* **06.12.16:** - Initial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue