Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-12 09:22:59 -05:00
rodzic 67e0f12b13
commit e3086786fb
1 zmienionych plików z 111 dodań i 61 usunięć

Wyświetl plik

@ -1,95 +1,145 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/photoshow](https://github.com/linuxserver/docker-photoshow)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://github.com/thibaud-rohmer/PhotoShow
[hub]: https://hub.docker.com/r/linuxserver/photoshow/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/photoshow.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/photoshow.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-photoshow/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-photoshow/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/index.html)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [Photoshow](https://github.com/thibaud-rohmer/PhotoShow) is gallery software at its easiest, it doesn't even require a database.
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/photoshow ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/photoshow.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/photoshow.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-photoshow)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-photoshow/)
[Photoshow][appurl] is gallery software at its easiest, it doesn't even require a database. 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).
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 |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
[![photoshow](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/photoshow-icon.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=photoshow \ --name=photoshow \
-v <path to data>:/config \ -e PUID=1001 \
-v <path to pictures>:/Pictures:ro \ -e PGID=1001 \
-v <path to store thumbs>:/Thumbs \ -e TZ=Europe/London \
-e PGID=<gid> -e PUID=<uid> \ -p 80:80 \
-e TZ=<timezone> \ -v <path to data>:/config \
-p 80:80 \ -v <path to pictures>:/Pictures:ro \
linuxserver/photoshow -v <path to store thumbs>:/Thumbs \
--restart unless-stopped \
linuxserver/photoshow
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
photoshow:
image: linuxserver/photoshow
container_name: photoshow
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path to pictures>:/Pictures:ro
- <path to store thumbs>:/Thumbs
ports:
- 80:80
mem_limit: 4096m
restart: unless-stopped
``` ```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. 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.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `80` | WebUI |
* `-p 80` - port for the webui ### Environment Variables (`-e`)
* `-v /config` - stores config and logs for nginx base
* `-v /Pictures` - your local folder of photos you wish to share
* `-v /Thumbs` - local folder to store thumbnails of your images
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
* `-e TZ` - for timezone information *eg Europe/London, etc*
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it photoshow /bin/bash`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### User / Group Identifiers ### Volume Mappings (`-v`)
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. | Volume | Function |
| :----: | --- |
| `/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. |
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
## 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`.
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=1001` and `PGID=1001`, to find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application ## 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. 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.
## Info
* To monitor the logs of the container in realtime `docker logs -f photoshow`. ## Support Info
* Shell access whilst the container is running:
* container version number * `docker exec -it photoshow /bin/bash`
* To monitor the logs of the container in realtime:
`docker inspect -f '{{ index .Config.Labels "build_version" }}' photoshow` * `docker logs -f photoshow`
* Container version number
* image version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' photoshow`
* Image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/photoshow` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/photoshow`
## Versions ## Versions
+ **16.01.19:** Add pipeline logic and multi arch. * **16.01.19:** - Add pipeline logic and multi arch.
+ **05.09.18:** Rebase to alpine 3.8. * **05.09.18:** - Rebase to alpine 3.8.
+ **07.01.18:** Rebase to alpine 3.7. * **07.01.18:** - Rebase to alpine 3.7.
+ **25.05.17:** Rebase to alpine 3.6. * **25.05.17:** - Rebase to alpine 3.6.
+ **03.05.17:** Use repo pinning to better solve dependencies, use repo version of php7-imagick. * **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.02.17:** - Rebase to alpine 3.5.
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer information.
+ **30.09.16:** Rebase to alpine linux. * **30.09.16:** - Rebase to alpine linux.
+ **11.09.16:** Add layer badges to README. * **11.09.16:** - Add layer badges to README.
+ **21.08.15:** Use patched keybaord js from fork of photoshow * **21.08.15:** - Use patched keybaord js from fork of photoshow.
+ **21.08.15:** Initial Release. * **21.08.15:** - Initial Release.