From 224dceb69ead1cdbcfcb0beb46f270c3bf6b7c41 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 19 Apr 2021 22:31:17 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-piwigo.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/images/docker-piwigo.md b/images/docker-piwigo.md index 25a76626f..f2d287d9b 100644 --- a/images/docker-piwigo.md +++ b/images/docker-piwigo.md @@ -1,6 +1,9 @@ --- title: piwigo --- + + + # [linuxserver/piwigo](https://github.com/linuxserver/docker-piwigo) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-piwigo.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-piwigo) @@ -29,6 +32,13 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +* 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. +* 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. ## Usage @@ -58,7 +68,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=piwigo \ -e PUID=1000 \ @@ -70,7 +80,6 @@ docker run -d \ ghcr.io/linuxserver/piwigo ``` - ## 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. @@ -81,7 +90,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `80` | Application WebUI | - ### Environment Variables (`-e`) | Env | Function | @@ -96,15 +104,13 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | Configuration files. | - - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -115,7 +121,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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. - ## 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`. @@ -124,25 +129,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -* 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. -* 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. - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=piwigo&query=%24.mods%5B%27piwigo%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=piwigo "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") 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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above. - ## Support Info * Shell access whilst the container is running: