Lychee

Container

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.

Image details

Pulls: 19.6M

Architecture: amd64, arm64

Image size: 139 MB

Latest: 7.7.3

User: linuxserver

Created: Jan 28, 2017

Updated: 9 hours ago

Status: active

Configuration

Type

Container

Platform

linux

Image

linuxserver/lychee:latest

Ports

80:80/tcp

Volumes

/config : /srv/lsio/lychee/config/pictures : /srv/lsio/lychee/pictures

Env vars

PUID=1000PGID=1000TZ=Etc/UTCDB_CONNECTION=DB_HOST=DB_PORT=DB_USERNAME=DB_PASSWORD=DB_DATABASE=APP_NAME=LycheeAPP_URL=TRUSTED_PROXIES=

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/lychee/config
mkdir -p /srv/lsio/lychee/pictures

Standalone Install

Select an install method, to see config/commands for deploying Lychee

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select Lychee, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

More install options in our documentation.

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/lychee

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-\
arm64	✅	arm64v8-\

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.
>!NOTE >Unless a parameter is flagged 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.

Parameter	Function
`-p 80:80`	http gui
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Etc/UTC`	specify a timezone to use, see this list.
`-e DBCONNECTION=`	DB type, from `sqlite`, `mysql`, `pqsql`.
`-e DBHOST=`	DB server hostname. For `mysql` and `pgsql` only.
`-e DBPORT=`	DB server port. For `mysql` and `pgsql` only.
`-e DBUSERNAME=`	DB user. For `mysql` and `pgsql` only.
`-e DBPASSWORD=`	DB password. For `mysql` and `pgsql` only.
`-e DBDATABASE=`	Path to DB file for `sqlite`. DB name for `mysql` and `pgsql`.
`-e APPNAME=Lychee`	The gallery name.
`-e APPURL=`	The URL you will use to access Lychee including protocol, and port where appropriate.
`-e TRUSTEDPROXIES=`	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`).
`-v /config`	Persistent config files.
`-v /pictures`	Where lychee will store uploaded images.

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:

```bash
docker exec -it lychee /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f lychee
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee
```

Image version number:

```bash
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:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull lychee
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d lychee
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/lychee:latest
```

Stop the running container:

```bash
docker stop lychee
```

Delete the container:

```bash
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:

```bash
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 x8664 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.
Versions
05.07.26: - Rebase to Alpine 3.24.
09.07.25: - Add php84-ldap as dependency.
09.07.25: - Rebase to Alpine 3.22.
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.

Serve Lychee on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying lychee.example.com to http://Lychee:80

Add this to your Caddyfile

lychee.example.com {
	reverse_proxy http://Lychee:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Lychee
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:80 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :80
Stop the other service, or pick a different host port. In 80:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:80. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Lychee can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 80

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/lychee/config (and the same for the other mapped folders)
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/lychee:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Lychee --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

DB_CONNECTION, DB_HOST, DB_PORT, DB_USERNAME, DB_PASSWORD, DB_DATABASE, APP_URL, TRUSTED_PROXIES have no default value, and Lychee may crash or misbehave if left empty.

Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within Lychee's repo
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

A single container

Lychee runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Lychee needs bundled into one download. This template pulls linuxserver/lychee:latest, which Docker fetches once (about 139 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Lychee's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 7.7.3. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 80:80 means it's reachable on port 80 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:80 in a browser. It opens:

80:80, likely the web interface

Volumes

A volume is where Lychee keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

/config from /srv/lsio/lychee/config on the host
/pictures from /srv/lsio/lychee/pictures on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Lychee takes 12 of them, and 8 need a value before it'll start properly:

PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.
DB_CONNECTION, needs a value. DB type, from sqlite, mysql, pqsql.
DB_HOST, needs a value. DB server hostname. For mysql and pgsql only.
DB_PORT, needs a value. DB server port. For mysql and pgsql only.
DB_USERNAME, needs a value. DB user. For mysql and pgsql only.
DB_PASSWORD, needs a value. DB password. For mysql and pgsql only.
DB_DATABASE, needs a value. Path to DB file for sqlite. DB name for mysql and pgsql.
APP_NAME, defaults to Lychee. The gallery name. [OPTIONAL]
APP_URL, needs a value. The URL you will use to access Lychee including protocol, and port where appropriate. [OPTIONAL]
TRUSTED_PROXIES, needs a value. 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). [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Lychee after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Lychee sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Lychee. That's what you'll spot in the containers list and use in commands like docker logs Lychee.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Lychee up. Add the template list to Portainer once, then deploying Lychee is a click rather than a wall of config.

Lychee

Image details

Configuration

Notes

Standalone Install

Install on Portainer

Template Import URL

Container Documentation

linuxserver/lychee

Supported Architectures

Application Setup

Customization

Increasing Upload Limit

Usage

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

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

Recent versions

Proxy configurator

Troubleshooting

Check the logs first

Port already in use

Running but the page won't load

Permission denied on volumes

Image won't pull

"exec format error"

Container keeps restarting

Required settings are blank

Raise an issue

Config glossary

A single container

The app image

Where the image comes from

Version tags

Which machines it runs on

Ports

Volumes

Environment variables

Restart policy

Users and permissions

Networking

Container name

Platform

Portainer app templates

Similar apps