diff --git a/images/docker-piwigo.md b/images/docker-piwigo.md index d3c1c532a..f3489bde2 100644 --- a/images/docker-piwigo.md +++ b/images/docker-piwigo.md @@ -1,30 +1,37 @@ -# linuxserver/piwigo +# [linuxserver/piwigo](https://github.com/linuxserver/docker-piwigo) -[![](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/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo) [![](https://images.microbadger.com/badges/image/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/piwigo.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/piwigo.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-piwigo/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-piwigo/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/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/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/piwigo.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/piwigo.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-piwigo/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-piwigo/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/index.html) [Piwigo](http://piwigo.org/) is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures. ## 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/piwigo` 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=piwigo \ -e PUID=1000 \ @@ -36,6 +43,7 @@ docker create \ linuxserver/piwigo ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -60,37 +68,40 @@ 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` | Application 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` | Configuration files. | + + ## 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) ``` @@ -99,10 +110,11 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * You must create a user and database for piwigo to use in a mysql/mariadb server. * In the setup page for database, use the ip address rather than hostname. -* A basic nginx configuration file can be found in `/config/nginx/site-confs`, edit the file to enable ssl \(port 443 by default\), set servername etc. +* A basic nginx configuration file can be found in `/config/nginx/site-confs`, edit the file to enable ssl (port 443 by default), set servername etc. * Self-signed keys are generated the first time you run the container and can be found in `/config/keys`, if needed, you can replace them with your own. * The easiest way to edit the configuration file is to enable local files editor from the plugins page and use it to configure email settings etc. + ## Support Info * Shell access whilst the container is running: @@ -127,4 +139,3 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **14.10.16:** - Add version layer information. * **10.09.16:** - Add layer badges to README. * **29.08.15:** - Initial Release. -