The LinuxServer.io team brings you another container release featuring:
Find us at:
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."
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 | ❌ |
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.
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.
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.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
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 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
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 |
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 DB_CONNECTION= |
DB type, from sqlite , mysql , pqsql . |
-e DB_HOST= |
DB server hostname. For mysql and pgsql only. |
-e DB_PORT= |
DB server port. For mysql and pgsql only. |
-e DB_USERNAME= |
DB user. For mysql and pgsql only. |
-e DB_PASSWORD= |
DB password. For mysql and pgsql only. |
-e DB_DATABASE= |
Path to DB file for sqlite . DB name for mysql and pgsql . |
-e APP_NAME=Lychee |
The gallery name. |
-e APP_URL= |
The URL you will use to access Lychee including protocol, and port where appropriate. |
-e 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`). |
-v /config |
Persistent config files. |
-v /pictures |
Where lychee will store uploaded images. |
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.
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.
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)
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.
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
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:
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
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
tip: We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
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 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
.