docker-documentation/images/docker-photoshow.md

175 wiersze
8.2 KiB
Markdown
Czysty Zwykły widok Historia

2020-04-28 21:25:13 +00:00
# [linuxserver/photoshow](https://github.com/linuxserver/docker-photoshow)
2020-06-02 21:24:47 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-photoshow.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-photoshow)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-photoshow.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-photoshow/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-photoshow/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-photoshow/container_registry)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/photoshow.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/photoshow "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/photoshow.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/photoshow)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/photoshow.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/photoshow)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-photoshow%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-photoshow/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flspipepr%2Fphotoshow%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/index.html)
2019-02-05 22:25:35 +00:00
2019-02-12 14:22:59 +00:00
[Photoshow](https://github.com/thibaud-rohmer/PhotoShow) is gallery software at its easiest, it doesn't even require a database.
2019-02-05 22:25:35 +00:00
2019-02-12 14:22:59 +00:00
## Supported Architectures
2019-02-05 22:25:35 +00:00
2019-09-03 21:24:53 +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-02-12 14:22:59 +00:00
Simply pulling `linuxserver/photoshow` 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 |
2020-04-28 21:25:13 +00:00
| :----: | --- |
2019-02-12 14:22:59 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 21:05:24 +00:00
| armhf | arm32v7-latest |
2019-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
2019-02-05 22:25:35 +00:00
## Usage
2019-02-12 14:22:59 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-04-28 21:25:13 +00:00
```
2019-02-05 22:25:35 +00:00
docker create \
2019-02-12 14:22:59 +00:00
--name=photoshow \
2019-03-05 22:24:48 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:22:59 +00:00
-e TZ=Europe/London \
-p 80:80 \
-v <path to data>:/config \
-v <path to pictures>:/Pictures:ro \
-v <path to store thumbs>:/Thumbs \
--restart unless-stopped \
linuxserver/photoshow
```
2020-04-28 21:25:13 +00:00
2019-02-12 14:22:59 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-07 21:25:17 +00:00
version: "2.1"
2019-02-12 14:22:59 +00:00
services:
photoshow:
image: linuxserver/photoshow
container_name: photoshow
environment:
2019-03-05 22:24:48 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:22:59 +00:00
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path to pictures>:/Pictures:ro
- <path to store thumbs>:/Thumbs
ports:
- 80:80
restart: unless-stopped
2019-02-05 22:25:35 +00:00
```
## Parameters
2020-04-28 21:25:13 +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-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
### Ports (`-p`)
2019-02-05 22:25:35 +00:00
2019-02-12 14:22:59 +00:00
| Parameter | Function |
2020-04-28 21:25:13 +00:00
| :----: | --- |
2019-02-12 14:22:59 +00:00
| `80` | WebUI |
2019-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
### Environment Variables (`-e`)
2019-02-05 22:25:35 +00:00
2019-02-12 14:22:59 +00:00
| Env | Function |
2020-04-28 21:25:13 +00:00
| :----: | --- |
2019-03-05 22:24:48 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:22:59 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
### Volume Mappings (`-v`)
2019-02-05 22:25:35 +00:00
2019-02-12 14:22:59 +00:00
| Volume | Function |
2020-04-28 21:25:13 +00:00
| :----: | --- |
2019-02-12 14:22:59 +00:00
| `/config` | Stores config and logs for nginx base. |
| `/Pictures:ro` | Your local folder of photos you wish to share. |
| `/Thumbs` | Local folder to store thumbnails of your images. |
2019-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
2020-06-02 21:24:47 +00:00
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## 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.
2020-04-28 21:25:13 +00:00
2019-02-12 14:22:59 +00:00
## User / Group Identifiers
2020-04-28 21:25:13 +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-02-05 22:25:35 +00:00
2019-02-12 14:22:59 +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.
2019-02-05 22:25:35 +00:00
2019-03-05 22:24:48 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
```
2019-02-12 14:22:59 +00:00
$ id username
2019-03-05 22:24:48 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-12 14:22:59 +00:00
```
## Application Setup
On first run create an admin account, any folder and its subfolders that you map to /Pictures will be presented as a webgallery. Config settings are persistent and stored as a subfolder of the /Thumbs mapping.
2019-02-05 22:25:35 +00:00
2020-04-28 21:25:13 +00:00
2020-04-07 21:25:17 +00:00
## Docker Mods
2020-06-02 21:24:47 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27photoshow%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=photoshow "view available mods for this container.")
2020-04-07 21:25:17 +00:00
2020-04-28 21:25:13 +00:00
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.
2020-04-07 21:25:17 +00:00
2019-10-01 21:25:38 +00:00
2019-02-12 14:22:59 +00:00
## Support Info
2019-02-05 22:25:35 +00:00
2019-09-03 21:24:53 +00:00
* Shell access whilst the container is running:
2019-02-12 14:22:59 +00:00
* `docker exec -it photoshow /bin/bash`
2019-09-03 21:24:53 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:22:59 +00:00
* `docker logs -f photoshow`
2019-09-03 21:24:53 +00:00
* Container version number
2019-02-12 14:22:59 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' photoshow`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/photoshow`
2019-02-05 22:25:35 +00:00
## Versions
2019-12-27 10:50:58 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-09-24 05:18:22 +00:00
* **23.09.19:** - Adding PHP-Exif for image metadata and processing.
2019-07-02 15:33:44 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 21:05:24 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 04:09:13 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-12 14:22:59 +00:00
* **16.01.19:** - Add pipeline logic and multi arch.
* **05.09.18:** - Rebase to alpine 3.8.
* **07.01.18:** - Rebase to alpine 3.7.
* **25.05.17:** - Rebase to alpine 3.6.
* **03.05.17:** - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
* **14.02.17:** - Rebase to alpine 3.5.
* **14.10.16:** - Add version layer information.
* **30.09.16:** - Rebase to alpine linux.
* **11.09.16:** - Add layer badges to README.
* **21.08.15:** - Use patched keybaord js from fork of photoshow.
* **21.08.15:** - Initial Release.