Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
11 contributors

Users who have contributed to this file

@ildyria @electerious @RobLui @d7415 @LudovicRousseau @jimmcslim @fly-man- @nemobis @edouardmenayde @bennettscience @benabbottnz
202 lines (164 sloc) 32 KB

Lychee

Release number license Gitter

A great looking and easy-to-use photo-management-system.

Since the 1st of April 2018 this project has moved to its own Organisation (https://github.com/LycheeOrg) where people are able to submit their fixes to it. We, the Organisation owners, want to thank electerious (Tobias Reich) for the opportunity to make this project live on.

Lychee 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. Read more on our Website.

Installation

To run Lychee, everything you need is a web-server with PHP 7.1 or later and a MySQL database. Follow the instructions to install Lychee on your server. Installation »

How to use

You can use Lychee right after the installation. Here are some advanced features to get the most out of it.

Settings

Sign in and click the gear in the top left corner to change your settings. If you want to edit them manually: MySQL details are stored in data/config.php. Other options and hidden settings are stored directly in the database. Settings »

Update

Updating is as easy as it should be. Update »

Build

Lychee is ready to use, right out of the box. If you want to contribute and edit CSS or JS files, you need to rebuild Lychee. Build »

Keyboard Shortcuts

These shortcuts will help you to use Lychee even faster. Keyboard Shortcuts »

Dropbox import

In order to use the Dropbox import from your server, you need a valid drop-ins app key from their website. Lychee will ask you for this key, the first time you try to use the import. Want to change your code? Take a look at the settings of Lychee.

Twitter Cards

Lychee supports Twitter Cards and Open Graph for shared images (not albums). In order to use Twitter Cards you need to request an approval for your domain. Simply share an image with Lychee, copy its link and paste it in Twitters Card Validator.

Imagick

Lychee uses Imagick when installed on your server. In this case you will benefit from a faster processing of your uploads, better looking thumbnails and intermediate sized images for small screen devices. You can disable the usage of Imagick in the settings.

Docker

Browse the Docker Hub Registry for various automated Lychee-Docker builds. Various docker builds include :

Plugins and Extensions

The plugin system of Lychee allows you to execute scripts when a certain action fires. Plugins are hooks, which are injected directly into Lychee. Plugin documentation »

It's also possible to build extensions upon Lychee. The way to do so isn't documented and can change every time. We recommend using the plugin system, when possible.

Here's a list of all available Plugins and Extensions:

Name Description
lycheesync Sync Lychee with any directory containing photos More »
lycheeupload Upload photos to Lychee via SSH More »
Jekyll Liquid tag for Jekyll sites that allows embedding Lychee albums More »
lychee-redirect Redirect from an album-name to a Lychee-album More »
lychee-watermark Adds a second watermarked photo when uploading images More »
lychee-rss Creates a RSS-Feed out of your photos More »
lychee-FlashAir Import from a Toshiba FlashAir WiFi SD card More »
lychee-webroot Controls photos accessibility and keeps Lychee files hidden More »
lychee-create-medium Generate missing medium size photos More »

Troubleshooting

Take a look at the FAQ if you have problems. Discovered a bug? Please create an issue here on GitHub!

Thanks to our contributors

Tobias Reich
Tobias Reich

💻 📖 🐛 🎨
Benoît Viguier
Benoît Viguier

💻 🐛 🎨 📖 🌍 👀
Ludovic Rousseau
Ludovic Rousseau

💻 🐛 📖 ⚠️ 👀
Clément Lamoureux
Clément Lamoureux

💻
d7415
d7415

💻 🐛
Brian
Brian

💻 🐛
Hermann Käser
Hermann Käser

🐛 💻
Alicia
Alicia

🌍
Peter Grassberger
Peter Grassberger

📦
Herald Yu
Herald Yu

🌍 🐛
arxcdr
arxcdr

🌍
jeyca
jeyca

🐛
Milo Cesar
Milo Cesar

🌍
Ben Abbott
Ben Abbott

📖
Bish Erbas
Bish Erbas

🐛 💻
Elias
Elias

💻
Job Evers‐Meltzer
Job Evers‐Meltzer

📦
Nemo
Nemo

💻
Fly Man
Fly Man

💻 📖
Edouard Menayde
Edouard Menayde

📖
Robbert
Robbert

📖
James Webster
James Webster

📖
Quentin Ligier
Quentin Ligier

💻
Michael Procter
Michael Procter

💻
Nils Asmussen
Nils Asmussen

💻
cternes
cternes

💻
Candid Dauth
Candid Dauth

💻
Rouven Hurling
Rouven Hurling

💻
Peter Hoffmann
Peter Hoffmann

💻
djdallmann
djdallmann

💻
Ricardo
Ricardo

💻
Powen Tan
Powen Tan

💻
Renfred Harper
Renfred Harper

📦
dixy
dixy

💻
Felix Eckhofer
Felix Eckhofer

💻
Bocquet Aldric
Bocquet Aldric

💻
Matthias Gutjahr
Matthias Gutjahr

💻
Quentin Bramas
Quentin Bramas

💻
Ben Snider
Ben Snider

💻
Joseph Pintozzi
Joseph Pintozzi

💻
Rene Luria
Rene Luria

💻
Nils Windisch
Nils Windisch

📖
Aron Brown
Aron Brown

💻
Mathieu Leplatre
Mathieu Leplatre

💻
Cronos87
Cronos87

💻
petter
petter

🐛
Andi Machovec
Andi Machovec

🌍
mkiric
mkiric

💻
Dmitry Krylov
Dmitry Krylov

💻
humantex
humantex

🐛
Guimik
Guimik

🐛
colinmcglothlin
colinmcglothlin

🐛
Tom Szilagyi
Tom Szilagyi

🐛
Andreas Schneider
Andreas Schneider

🐛
fatherb
fatherb

🐛
Luc Bonnefond
Luc Bonnefond

🐛
Sebastian Chrobak
Sebastian Chrobak

🐛
Harri Häivälä
Harri Häivälä

🐛
Carl
Carl

🐛
結城イヴ
結城イヴ

🐛
Dirk
Dirk

🐛
corrilan
corrilan

🐛
Himself132
Himself132

🐛
Samuel FORESTIER
Samuel FORESTIER

📖
Daniel Swarbrick
Daniel Swarbrick

🐛
Jonas
Jonas

💻
capulo
capulo

🐛
ezek1el
ezek1el

🐛
anroth76
anroth76

💻
Gabriel
Gabriel

🐛
dbw3
dbw3

🐛
nemobis
nemobis

📖
roblandry
roblandry

🐛 💻 🚇
Michael Rasmussen
Michael Rasmussen

🐛 💻
kamil4
kamil4

🐛 💻
rwa
rwa

💻 🐛
copperschnack
copperschnack

💻
Edoardo Grassi
Edoardo Grassi

🌍
Edward Betts
Edward Betts

🌍
romansirokov
romansirokov

💻
yxhlcl
yxhlcl

🐛 💻
You can’t perform that action at this time.