kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
6e54ac08a8
commit
6d3238cb18
|
|
@ -1,6 +1,9 @@
|
|||
---
|
||||
title: ubooquity
|
||||
---
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-ubooquity/blob/master/.github/CONTRIBUTING.md -->
|
||||
|
||||
# [linuxserver/ubooquity](https://github.com/linuxserver/docker-ubooquity)
|
||||
|
||||
[](https://github.com/linuxserver/docker-ubooquity)
|
||||
|
|
@ -14,7 +17,6 @@ title: ubooquity
|
|||
[](https://ci-tests.linuxserver.io/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.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -29,6 +31,24 @@ The architectures supported by this image are:
|
|||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
## 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.
|
||||
|
||||
Access the admin page at `http://<your-ip>:2203/ubooquity/admin` and set a password.
|
||||
|
||||
Then you can access the webui at `http://<your-ip>:2202/ubooquity/`
|
||||
|
||||
This container will automatically scan your files at startup.
|
||||
|
||||
### 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). Value is a number of megabytes ( put just a number, without MB )
|
||||
|
||||
If no value is set it will default to 512MB.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -63,7 +83,7 @@ services:
|
|||
|
||||
### docker cli
|
||||
|
||||
```
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=ubooquity \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -80,7 +100,6 @@ docker run -d \
|
|||
ghcr.io/linuxserver/ubooquity
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
|
@ -92,7 +111,6 @@ Docker images are configured using parameters passed at runtime (such as those a
|
|||
| `2202` | The library port. |
|
||||
| `2203` | The admin port. |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
|
|
@ -111,15 +129,13 @@ Docker images are configured using parameters passed at runtime (such as those a
|
|||
| `/comics` | Location of comics. |
|
||||
| `/files` | Location of raw files. |
|
||||
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```
|
||||
```bash
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -130,7 +146,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
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`.
|
||||
|
|
@ -139,37 +154,17 @@ Ensure any volume directories on the host are owned by the same user you specify
|
|||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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.
|
||||
|
||||
Access the admin page at `http://<your-ip>:2203/ubooquity/admin` and set a password.
|
||||
|
||||
Then you can access the webui at `http://<your-ip>:2202/ubooquity/`
|
||||
|
||||
This container will automatically scan your files at startup.
|
||||
|
||||
### 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). 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=universal "view available universal mods.")
|
||||
|
||||
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue