From de206321a4c32eed8c9ac1040d540388965b7964 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 2 Apr 2019 17:24:59 -0400 Subject: [PATCH] Bot Updating Templated Files --- images/docker-photoshow.md | 42 ++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/images/docker-photoshow.md b/images/docker-photoshow.md index 819688f68..9125dfc01 100644 --- a/images/docker-photoshow.md +++ b/images/docker-photoshow.md @@ -1,30 +1,37 @@ -# linuxserver/photoshow +# [linuxserver/photoshow](https://github.com/linuxserver/docker-photoshow) -[![](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) [![](https://images.microbadger.com/badges/image/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow) ![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) +[![](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) [Photoshow](https://github.com/thibaud-rohmer/PhotoShow) is gallery software at its easiest, it doesn't even require a database. ## 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/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 | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=photoshow \ -e PUID=1000 \ @@ -38,6 +45,7 @@ docker create \ linuxserver/photoshow ``` + ### 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 `:` 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 `:` 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 | -| :---: | :--- | +| :----: | --- | | `80` | 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 | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | 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. | + + ## 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,6 +116,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel 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. + + ## Support Info * Shell access whilst the container is running: @@ -131,4 +144,3 @@ On first run create an admin account, any folder and its subfolders that you map * **11.09.16:** - Add layer badges to README. * **21.08.15:** - Use patched keybaord js from fork of photoshow. * **21.08.15:** - Initial Release. -