Self-host Lychee with Levelrail

A self-hosted photo management and gallery app with albums, sharing and public links. MIT licensed. Runs on SQLite in one container. On first open, the setup page asks you to create the admin login.

  • AuthorLycheeOrg
  • LicenceMIT
  • Memory384 MiB
  • Archarm64
  • Services1

How to self-host Lychee

  1. Pull the images

    One image is pulled on your server.

    Show images
    • ghcr.io/lycheeorg/lychee:v7.12.0
  2. Create the app

    One service starts in a single Compose app, with 3 named volume mounts for your data, on port 8000.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 8 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Lychee requirements

Memory
About 384 MiB
Architectures
amd64 image published, arm64 image published
Ports
8000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Lychee. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Lychee docs page.

Deploy Lychee your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Lychee from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain lychee=app.example.com.

levelrail-cli templates install lychee --name my-lychee

Deploy Lychee with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/lychee/install \
  -d '{
    "name": "my-lychee"
  }'

Lychee configuration

Lychee services

ServiceImagePortsVolumes
lychee ghcr.io/lycheeorg/lychee:v7.12.0 8000 data -> /datauploads -> /app/public/uploadsstorage -> /app/storage/app

Lychee environment variables

VariableServiceValue
APP_DEBUG lychee Preset by the template
APP_ENV lychee Preset by the template
APP_KEY lychee Generated at deploy
APP_URL lychee Preset by the template
DB_CONNECTION lychee Preset by the template
DB_DATABASE lychee Preset by the template
PHP_TZ lychee Preset by the template
TIMEZONE lychee Preset by the template
Show all 9 variables
  • TRUSTED_PROXIESlycheePreset by the template

Ports and volumes

Ports
8000
Volumes
3 named mounts: data -> /data, uploads -> /app/public/uploads, storage -> /app/storage/app

Lychee FAQ

How much memory does Lychee need?

The catalog lists about 384 MiB of memory for Lychee.

Does Lychee run on arm64?

For Lychee, an arm64 image is published; amd64 is image published.

What licence is Lychee under?

Lychee is licensed under MIT, which is permissive, with few conditions on reuse.

Does Lychee need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does Lychee use?

Lychee listens on port 8000 inside the stack.

Where does Lychee keep its data?

In named volumes: data mounted at /data, uploads mounted at /app/public/uploads and storage mounted at /app/storage/app.

Can I deploy Lychee on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Lychee, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/lycheeorg/lychee:v7.12.0 is what you deploy there.

levelrail-cli templates install lychee --name my-lychee