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.

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

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.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

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

---
services:
  lychee:
    image: lscr.io/linuxserver/lychee:latest
    container_name: lychee
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DB_CONNECTION=
      - DB_HOST=
      - DB_PORT=
      - DB_USERNAME=
      - DB_PASSWORD=
      - DB_DATABASE=
      - APP_NAME=Lychee #optional
      - APP_URL= #optional
      - TRUSTED_PROXIES= #optional
    volumes:
      - /path/to/lychee/config:/config
      - /path/to/pictures:/pictures
    ports:
      - 80:80
    restart: unless-stopped

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= \
  -e DB_HOST= \
  -e DB_PORT= \
  -e DB_USERNAME= \
  -e DB_PASSWORD= \
  -e DB_DATABASE= \
  -e APP_NAME=Lychee `#optional` \
  -e APP_URL= `#optional` \
  -e TRUSTED_PROXIES= `#optional` \
  -p 80:80 \
  -v /path/to/lychee/config:/config \
  -v /path/to/pictures:/pictures \
  --restart unless-stopped \
  lscr.io/linuxserver/lychee: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: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=`	DB type, from `sqlite`, `mysql`, `pqsql`.
`DB_HOST=`	DB server hostname. For `mysql` and `pgsql` only.
`DB_PORT=`	DB server port. For `mysql` and `pgsql` only.
`DB_USERNAME=`	DB user. For `mysql` and `pgsql` only.
`DB_PASSWORD=`	DB password. For `mysql` and `pgsql` only.
`DB_DATABASE=`	Path to DB file for `sqlite`. DB name for `mysql` and `pgsql`.
`APP_NAME=Lychee`	The gallery name.
`APP_URL=`	The URL you will use to access Lychee including protocol, and port where appropriate.
`TRUSTED_PROXIES=`	Set to the IP or netmask covering your reverse proxy, if running behind one. Set to `` to trust all IPs (do not* use `*` if exposed to the internet`).

Volume Mappings (`-v`)¶

Volume	Function
`/config`	Persistent config files.
`/pictures`	Where lychee will store uploaded images.

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

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 lychee
```

Update containers:

All containers:
```
docker-compose up -d
```
Single container:
```
docker-compose up -d lychee
```

You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run¶

Update the image:

docker pull lscr.io/linuxserver/lychee:latest

Stop the running container:
```
docker stop lychee
```
Delete the container:
```
docker rm lychee
```
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 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-lychee.git
cd docker-lychee
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/lychee:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

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

To help with development, we generate this dependency graph.

Init dependency graph

Versions¶

03.12.24: - Verify build artifacts with cosign.
27.05.24: - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
18.01.24: - Add php-sodium.
13.01.24: - Rebase to Alpine 3.19 with php 8.3.
27.12.23: - Update image to support v5.
25.12.23: - Existing users should update: site-confs/default.conf - Cleanup default site conf. Build npm dependencies into image.
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.

linuxserver/lychee¶