docker-documentation/docs/images/docker-piwigo.md

title
piwigo

linuxserver/piwigo

Piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/piwigo:latest 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	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup

• You must create a user and database for piwigo to use in a mysql/mariadb server.

• 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

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
services:
  piwigo:
    image: lscr.io/linuxserver/piwigo:latest
    container_name: piwigo
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/piwigo/config:/config
      - /path/to/appdata/gallery:/gallery
    ports:
      - 80:80
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=piwigo \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 80:80 \
  -v /path/to/piwigo/config:/config \
  -v /path/to/appdata/gallery:/gallery \
  --restart unless-stopped \
  lscr.io/linuxserver/piwigo:latest

Parameters

Containers 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.

Ports (-p)

Parameter	Function
80	Application WebUI

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Etc/UTC	specify a timezone to use, see this list.

Volume Mappings (-v)

Volume	Function
/config	Persistent config files
/gallery	Image storage for Piwigo

Miscellaneous Options

Parameter	Function

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 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.

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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various 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:

  docker exec -it piwigo /bin/bash
  

• To monitor the logs of the container in realtime:

  docker logs -f piwigo
  

• Container version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' piwigo
  

• Image version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/piwigo:latest
  

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update images:

  • All images:

    docker-compose pull
    

  • Single image:

    docker-compose pull piwigo
    

• Update containers:

  • All containers:

    docker-compose up -d
    

  • Single container:

    docker-compose up -d piwigo
    

• You can also remove the old dangling images:

  docker image prune
  

Via Docker Run

• Update the image:

  docker pull lscr.io/linuxserver/piwigo:latest
  

• Stop the running container:

  docker stop piwigo
  

• Delete the container:

  docker rm piwigo
  

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune
  

Image Update Notifications - Diun (Docker Image Update Notifier)

!!! tip

We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-piwigo.git
cd docker-piwigo
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/piwigo:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 02.03.24: - Fix HEIC file format support.
• 23.12.23: - Rebase to Alpine 3.19 with php 8.3.
• 12.12.23: - Rebase to Alpine 3.18.
• 03.06.23: - Revert to Alpine 3.17 due to compatibility issues with php 8.2.
• 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
• 20.01.23: - Rebase to alpine 3.17 with php8.1.
• 16.01.23: - Fix broken custom template persistence.
• 08.11.22: - Rebase to Alpine 3.16, migrate to s6v3. Move application install to /app/www/public, add migration for existing users. Container updates should now update the application correctly.
• 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
• 29.06.21: - Rebase to 3.14, Add php7-zip package
• 20.05.21: - Create separate volume for image data
• 23.01.21: - Rebasing to alpine 3.13.
• 12.12.20: - Increased upload_max_filesize in php.ini
• 01.06.20: - Rebasing to alpine 3.12.
• 19.12.19: - Rebasing to alpine 3.11.
• 28.06.19: - Rebasing to alpine 3.10.
• 12.06.19: - Add ffmpeg and other deps as needed by popular plugins.
• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 01.03.19: - Add php-ctype & php-curl.
• 22.02.19: - Rebasing to alpine 3.9, add php-ldap.
• 28.01.19: - Rebase to alpine linux 3.8 , add pipeline logic and multi arch.
• 25.01.18: - Rebase to alpine linux 3.7.
• 25.05.17: - Rebase to alpine linux 3.6.
• 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
• 20.04.17: - Add php7-exif package, thanks iiska
• 23.02.17: - Rebase to alpine linux 3.5 and nginx.
• 14.10.16: - Add version layer information.
• 10.09.16: - Add layer badges to README.
• 29.08.15: - Initial Release.