docker-documentation/images/docker-pixapop.md

128 wiersze
5.1 KiB
Markdown
Czysty Zwykły widok Historia

2019-09-29 09:44:22 +00:00
# linuxserver/pixapop
2019-03-17 23:50:17 +00:00
2019-09-29 09:44:22 +00:00
[![GitHub Release](https://img.shields.io/github/release/lsiocommunity/docker-pixapop.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-pixapop/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/lsiocommunity/pixapop.svg?style=flat-square&color=E68523)](https://microbadger.com/images/lsiocommunity/pixapop) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/lsiocommunity/pixapop.svg?style=flat-square&color=E68523)](https://microbadger.com/images/lsiocommunity/pixapop) [![Docker Pulls](https://img.shields.io/docker/pulls/lsiocommunity/pixapop.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/lsiocommunity/pixapop) [![Docker Stars](https://img.shields.io/docker/stars/lsiocommunity/pixapop.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/lsiocommunity/pixapop) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-pixapop/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-pixapop/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/lsiocommunity/pixapop/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/lsiocommunity/pixapop/latest/index.html)
2019-03-17 23:50:17 +00:00
2019-03-19 01:50:33 +00:00
[Pixapop](https://github.com/bierdok/pixapop) is an open-source single page application to view your photos in the easiest way possible.
2019-03-17 23:50:17 +00:00
## Supported Architectures
2019-09-05 21:54:38 +00:00
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/).
2019-03-17 23:50:17 +00:00
2019-03-19 01:50:33 +00:00
Simply pulling `lsiocommunity/pixapop` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-03-17 23:50:17 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-03-17 23:50:17 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 11:36:31 +00:00
| armhf | arm32v7-latest |
2019-03-17 23:50:17 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-09-29 09:44:22 +00:00
```text
2019-03-17 23:50:17 +00:00
docker create \
--name=pixapop \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e APP_USERNAME=admin `#optional` \
-e APP_PASSWORD=admin `#optional` \
-p 80:80 \
-v <path to config>:/config \
-v <path to photos>:/photos \
--restart unless-stopped \
2019-03-19 01:50:33 +00:00
lsiocommunity/pixapop
2019-03-17 23:50:17 +00:00
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
pixapop:
2019-03-19 01:50:33 +00:00
image: lsiocommunity/pixapop
2019-03-17 23:50:17 +00:00
container_name: pixapop
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- APP_USERNAME=admin #optional
- APP_PASSWORD=admin #optional
volumes:
- <path to config>:/config
- <path to photos>:/photos
ports:
- 80:80
restart: unless-stopped
```
## Parameters
2019-09-29 09:44:22 +00:00
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.
2019-03-17 23:50:17 +00:00
2019-09-29 09:44:22 +00:00
### Ports \(`-p`\)
2019-03-17 23:50:17 +00:00
| Parameter | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-03-17 23:50:17 +00:00
| `80` | WebUI |
2019-09-29 09:44:22 +00:00
### Environment Variables \(`-e`\)
2019-03-17 23:50:17 +00:00
| Env | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-03-17 23:50:17 +00:00
| `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. |
| `APP_USERNAME=admin` | Specify a username to enable authentication. |
| `APP_PASSWORD=admin` | Specify a password to enable authentication. |
2019-09-29 09:44:22 +00:00
### Volume Mappings \(`-v`\)
2019-03-17 23:50:17 +00:00
| Volume | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-03-17 23:50:17 +00:00
| `/config` | Stores config and logs for nginx base. |
| `/photos` | Your local folder of photos. |
## User / Group Identifiers
2019-09-29 09:44:22 +00:00
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`.
2019-03-17 23:50:17 +00:00
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:
2019-09-29 09:44:22 +00:00
```text
2019-03-17 23:50:17 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
Any photos included in /photos will be presented as galleries split by month. Config settings are persistent and stored into /config.
## Support Info
2019-09-05 21:54:38 +00:00
* Shell access whilst the container is running:
2019-03-17 23:50:17 +00:00
* `docker exec -it pixapop /bin/bash`
2019-09-05 21:54:38 +00:00
* To monitor the logs of the container in realtime:
2019-03-17 23:50:17 +00:00
* `docker logs -f pixapop`
2019-09-05 21:54:38 +00:00
* Container version number
2019-03-17 23:50:17 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' pixapop`
* Image version number
2019-03-19 01:50:33 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lsiocommunity/pixapop`
2019-03-17 23:50:17 +00:00
## Versions
2019-03-19 01:50:33 +00:00
* **18.03.19** - Update build dependencies
2019-03-18 01:18:10 +00:00
* **18.03.19** - Add build dependencies
2019-03-17 23:50:17 +00:00
* **17.03.19** - Initial release
2019-09-29 09:44:22 +00:00