docker-documentation/images/docker-lychee.md

title
lychee

linuxserver/lychee

Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely."

UPGRADE WARNING

Please note that the v4 upgrade process resets ALL password-protected albums. Any albums that were made public with a password will need to be re-secured.

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/lychee: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

This image will not work with a prefilled /pictures mount, lychee wants total control over this folder

Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT More info at lychee.

Customization

In certain scenarios, you might need to change the default settings of Lychee. For instance, if you encounter limitations when uploading large files, you can increase this limit.

Increasing Upload Limit

The upload limit is defined in the user.ini file located in the config directory (/config). You can increase this limit by modifying the following values:

post_max_size = 500M
upload_max_filesize = 500M

After making these changes, you'll need to restart the Docker container for the changes to take effect. Here's how to do it:

Please note that these changes might have implications on your server's performance, depending on its available resources. Thus, it's recommended to modify these settings with caution.

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)

version: "3"
services:
  mariadb:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: lychee_mariadb
    restart: always
    volumes:
      - /path/to/mariadb/data:/config
    environment:
      - MYSQL_ROOT_PASSWORD=rootpassword
      - MYSQL_DATABASE=lychee
      - MYSQL_USER=lychee
      - MYSQL_PASSWORD=dbpassword
      - PGID=1000
      - PUID=1000
      - TZ=Europe/London
  lychee:
    image: lscr.io/linuxserver/lychee:latest
    container_name: lychee
    restart: always
    depends_on:
      - mariadb
    volumes:
      - /path/to/config:/config
      - /path/to/pictures:/pictures
    environment:
      - DB_CONNECTION=mysql
      - DB_HOST=mariadb
      - DB_PORT=3306
      - DB_USERNAME=lychee
      - DB_PASSWORD=dbpassword
      - DB_DATABASE=lychee
      - PGID=1000
      - PUID=1000
      - TZ=Europe/London
    ports:
      - 80:80

docker cli (click here for more info)

docker run -d \
  --name=lychee \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DB_CONNECTION=mysql \
  -e DB_HOST=mariadb \
  -e DB_PORT=3306 \
  -e DB_USERNAME=lychee \
  -e DB_PASSWORD=dbpassword \
  -e DB_DATABASE=lychee \
  -p 80:80 \
  -v /path/to/config:/config \
  -v /path/to/pictures:/pictures \
  --restart unless-stopped \
  lscr.io/linuxserver/lychee:latest

Parameters

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.

Ports (-p)

Parameter	Function
80	http gui

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.
DB_CONNECTION=mysql	for specifying the database type
DB_HOST=mariadb	for specifying the database host
DB_PORT=3306	for specifying the database port
DB_USERNAME=lychee	for specifying the database user
DB_PASSWORD=dbpassword	for specifying the database password
DB_DATABASE=lychee	for specifying the database to be used

Volume Mappings (-v)

Volume	Function
/config	Contains all relevant configuration files.
/pictures	Where lychee will store uploaded data.

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__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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 lychee /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f lychee
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lychee:latest

Versions

• 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
• 13.04.23: - Move ssl.conf include to default.conf.
• 11.01.23: - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs (see changes announcement). Switch to git clone as builds fail with the release artifact.
• 13.05.21: - Make readme clearer.
• 18.04.21: - Add php-intl for v4.3.
• 31.01.21: - Add jpegoptim.
• 15.01.21: - Rebase to alpine 3.13, add php7-ctype.
• 10.07.20: - Upgrade to Lychee v4 and rebased to alpine 3.12.
• 19.12.19: - Rebasing to alpine 3.11.
• 23.10.19: - Increase fastcgi timeouts (existing users need to manually update).
• 19.09.19: - Update project website url.
• 28.06.19: - Rebasing to alpine 3.10.
• 05.05.19: - Rebase to alpine 3.9, use new armv7 image format.
• 21.01.18: - Added ffmpeg for video thumbnail creation, switched to installing zip release instead of source tarball, created small thumbnails folder, switched to dynamic readme.
• 14.01.19: - Adding pipeline logic and multi arch..
• 04.09.18: - Rebase to alpine 3.8, switch to LycheeOrg repository.
• 08.01.18: - Rebase to alpine 3.7.
• 25.05.17: - Rebase to alpine 3.6.
• 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
• 12.02.17: - Initial Release.