Admin Panel
Everything an administrator can do lives behind the Admin entry of the left menu. How it is presented depends on the use_admin_dashboard setting:
- on (default) - the entry leads to
/admin, a dashboard page with an overview and a grid of tiles. - off - the entry expands into a submenu listing the same destinations directly.
Either way, a screen only ever shows up for someone who has the rights to use it, and only when the module behind it is enabled.
The dashboard
Section titled “The dashboard”The overview at the top reports the number of photos, albums, and users, the storage in use, the number of queued jobs, the failed jobs of the last 24 hours, and when the last job succeeded. A metric that cannot be computed is reported as partially unavailable rather than blocking the page.
Two panels appear above it when they have something to say:
- Security Advisories - the advisories published for Lychee that apply to the version you are running, with their CVSS score when there is one. Lychee fetches them from
ADVISORIES_API_URL(GitHub’s advisory API by default) and also shows a dismissable warning at login. Turn the whole check off withVULNERABILITY_CHECK_ENABLED=false. - Update Status - whether a newer release exists, and which one. Turn it off with
UPDATE_CHECK_ENABLED=false.
The tiles below are grouped into Admin, Monitoring, and Extensions.
| Screen | What it does |
|---|---|
| Settings | Every setting of the instance. See Settings |
| Users | Create, edit, and delete accounts. See Users |
| User Groups SE | Gather users into groups. See User Groups |
| Sharing v8 | Every album permission on the instance, in one editable table, with propagation and bulk sharing. Reachable from the profile menu in any case |
| Bulk Album Edit | Titles, metadata, visibility, sorting, ownership, and deletion for many albums at once |
| Moderation | Photos held back by the check trust level, awaiting approval or deletion |
| Maintenance | The maintenance tasks, listed below |
| Design System v8 | The theme’s colours, typography, and components, previewed live. Needs enable_design_system |
Monitoring
Section titled “Monitoring”| Screen | What it does |
|---|---|
| Diagnostics | Self-diagnosis checks, instance info, configuration dump, and storage usage, copyable to the clipboard |
| Jobs | The job history: date, status, user, and job name |
| Logs | The application log, served by the built-in log viewer. Requires LOG_VIEWER_ENABLED=true |
| Clockwork | The Clockwork profiler, when developer tools are enabled |
Individual diagnostic checks can be skipped with SKIP_DIAGNOSTICS_CHECKS in the .env file, which is how you drop an expensive check such as BasicPermissionCheck on slow storage. See Advanced Setups.
Extensions
Section titled “Extensions”These only appear when the matching module is enabled.
| Screen | Enabled by |
|---|---|
| Purchasables | The Webshop |
| Shop Sizes | The Webshop |
| Contact Messages SE | The contact form |
| Webhooks | WEBHOOK_ENABLED=true |
| Face Quality Review v8 | Facial Recognition |
| NSFW Detection & Moderation SE | NSFW Classification |
| Watermark Preview v8SE | Watermarking |
| Landing Config v8 | Always, in v8 |
The Contact Messages tile also carries a badge with the number of unread messages.
Maintenance tasks
Section titled “Maintenance tasks”The maintenance page runs one-off housekeeping jobs. Each one reports what it found before you let it act:
- Cleaning - remove leftover files that no longer belong to any photo.
- Missing size variants and File sizes missing - regenerate variants that were never produced, and backfill the recorded file sizes.
- Missing Palettes SE - compute the colour palettes of photos imported before extraction was turned on.
- Duplicates - find duplicate photos by checksum and/or title, optionally restricted to the same album, and delete the copies you do not keep. Also available as its own page.
- Tree statistics and Album Precomputed Fields / Album Size Statistics - rebuild the album tree’s nested-set bounds and the counters cached on albums.
- Statistics integrity Check - verify the stored statistics against the actual data.
- Optimize Database - run the database engine’s own optimisation.
- Fixing Jobs History and Flush Queue - clean up the job history and drop what is still queued.
- Flush Cache - empty the response cache.
- Updates - check whether the installation is behind, and run the updater when it is.
- Old Orders and Orders to fulfill - clean stale baskets and re-run auto-fulfilment. See Order Management.
- Face Quality Review, Destroy Dismissed Faces, Sync Face Embeddings, Reset Face Scan Status, Purge Orphan Face Embeddings, Run Clustering v8 - the facial-recognition housekeeping. See Facial Recognition.
- Bulk NSFW Scan SE - scan existing photos with the classifier. See NSFW Classification.
Two related pages sit next to it: Fix Tree, which exposes the raw nested-set values of the album tree for manual repair, and the Duplicates Finder.