kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
0c25381ef3
commit
5e271dc8d4
|
|
@ -1,30 +1,37 @@
|
|||
# linuxserver/gazee
|
||||
# [linuxserver/gazee](https://github.com/linuxserver/docker-gazee)
|
||||
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/gazee) [](https://microbadger.com/images/linuxserver/gazee)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-gazee/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/gazee/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/gazee "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/gazee "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-gazee/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/gazee/latest/index.html)
|
||||
|
||||
[Gazee](https://github.com/hubbcaps/gazee) is a WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser.
|
||||
|
||||
## 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/).
|
||||
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/).
|
||||
|
||||
Simply pulling `linuxserver/gazee` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
|
||||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=gazee \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -38,6 +45,7 @@ docker create \
|
|||
linuxserver/gazee
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -64,39 +72,42 @@ 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 |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `4242` | WebUI |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Where Gazee should store config files. |
|
||||
| `/comics` | Path to comics folder. |
|
||||
| `/mylar` | Path to Mylar DB. |
|
||||
| `/certs` | Where SSL certs should be stored. |
|
||||
|
||||
|
||||
|
||||
## 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)
|
||||
```
|
||||
|
|
@ -105,10 +116,10 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Webui can be found at `your-ip:4242`
|
||||
|
||||
Default username and password for the web interface:
|
||||
Default username and password for the web interface:
|
||||
|
||||
* **Username:** `admin`
|
||||
* **Password:** `gazee`
|
||||
* **Username:** `admin`
|
||||
* **Password:** `gazee`
|
||||
|
||||
Click the gear icon to go to the settings page.
|
||||
|
||||
|
|
@ -116,14 +127,16 @@ Change the default admin password or add a new admin and remove the admin user a
|
|||
|
||||
Comic path should be set to `/comics`
|
||||
|
||||
_Optional_ Mylar DB path should be set to `/mylar`
|
||||
*Optional* Mylar DB path should be set to `/mylar`
|
||||
|
||||
_Optional_ path for certificates and keys should be set to `/certs`
|
||||
*Optional* path for certificates and keys should be set to `/certs`
|
||||
|
||||
After you update the settings, Gazee will restart and begin an intial scan of your comic library.
|
||||
|
||||
Happy Reading!
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -141,4 +154,3 @@ Happy Reading!
|
|||
* **17.08.18:** - Rebase to alpine 3.8.
|
||||
* **30.12.17:** - Ensure version 11 of cherrypy.
|
||||
* **07.12.17:** - Initial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue