Search…
Images
Powered By GitBook
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

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 and our announcement here.
Simply pulling lscr.io/linuxserver/lychee 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
arm32v7-latest

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.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
version: "3"
2
services:
3
mariadb:
4
image: ghcr.io/linuxserver/mariadb:latest
5
container_name: lychee_mariadb
6
restart: always
7
volumes:
8
- /path/to/mariadb/data:/config
9
environment:
10
- MYSQL_ROOT_PASSWORD=rootpassword
11
- MYSQL_DATABASE=lychee
12
- MYSQL_USER=lychee
13
- MYSQL_PASSWORD=dbpassword
14
- PGID=1000
15
- PUID=1000
16
- TZ=Europe/London
17
lychee:
18
image: ghcr.io/linuxserver/lychee:latest
19
container_name: lychee
20
restart: always
21
depends_on:
22
- mariadb
23
volumes:
24
- /path/to/config:/config
25
- /path/to/pictures:/pictures
26
environment:
27
- DB_HOST=mariadb
28
- DB_USERNAME=lychee
29
- DB_PASSWORD=dbpassword
30
- DB_DATABASE=lychee
31
- DB_PORT=3306
32
- PGID=1000
33
- PUID=1000
34
- TZ=Europe/London
35
ports:
36
- 80:80
Copied!
1
docker run -d \
2
--name=lychee \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-e DB_HOST=mariadb \
7
-e DB_USERNAME=lychee \
8
-e DB_PASSWORD=dbpassword \
9
-e DB_DATABASE=lychee \
10
-p 80:80 \
11
-v /path/to/config:/config \
12
-v /path/to/pictures:/pictures \
13
--restart unless-stopped \
14
lscr.io/linuxserver/lychee
Copied!

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=Europe/London
Specify a timezone to use EG Europe/London
DB_HOST=mariadb
for specifying the database host
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:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

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

Versions

    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.
Last modified 19d ago