Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LycheeOrg/Lychee-v3
A great looking and easy-to-use photo-management-system you can run on your server, to manage and share photos.
https://github.com/LycheeOrg/Lychee-v3
management photo-gallery photography
Last synced: 8 days ago
JSON representation
A great looking and easy-to-use photo-management-system you can run on your server, to manage and share photos.
- Host: GitHub
- URL: https://github.com/LycheeOrg/Lychee-v3
- Owner: LycheeOrg
- License: mit
- Archived: true
- Created: 2018-04-22T20:22:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-10T02:33:37.000Z (over 3 years ago)
- Last Synced: 2024-10-30T00:55:25.277Z (15 days ago)
- Topics: management, photo-gallery, photography
- Language: PHP
- Homepage: https://lycheeorg.github.io/
- Size: 3.76 MB
- Stars: 945
- Watchers: 44
- Forks: 95
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Lychee
[](https://github.com/LycheeOrg/Lychee-v3/releases)
[](https://github.com/LycheeOrg/Lychee-v3/blob/master/LICENSE)
[](https://gitter.im/LycheeOrg/Lobby)
## With the release of [version 4](https://github.com/LycheeOrg/Lychee), this repository is now obsolete. For upgrade instructions, see [this](https://github.com/LycheeOrg/Lychee/wiki/Upgrade-from-version-3) page. To find out what's changed, see the [changelog](https://github.com/LycheeOrg/Lychee/wiki/Changelog).
#### 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 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](https://LycheeOrg.github.io).
## 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 »](https://github.com/LycheeOrg/Lychee-v3/wiki/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 »](https://github.com/LycheeOrg/Lychee-v3/wiki/Settings)
### Update
Updating is as easy as it should be. [Update »](https://github.com/LycheeOrg/Lychee-v3/wiki/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 »](https://github.com/LycheeOrg/Lychee-v3/wiki/Build)
### Keyboard Shortcuts
These shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](https://github.com/LycheeOrg/Lychee-v3/wiki/Keyboard%20Shortcuts)
### Dropbox import
In order to use the Dropbox import from your server, you need a valid drop-ins app key from [their website](https://www.dropbox.com/developers/apps/create). 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](https://github.com/LycheeOrg/Lychee-v3/wiki/Settings) of Lychee.
### Twitter Cards
Lychee supports [Twitter Cards](https://dev.twitter.com/docs/cards) and [Open Graph](http://opengraphprotocol.org) for shared images ([not albums](https://github.com/electerious/Lychee/issues/384)). 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](https://dev.twitter.com/docs/cards/validation/validator).
### Imagick
Lychee uses [Imagick](https://www.imagemagick.org) 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](https://www.imagemagick.org) in [the settings](https://github.com/LycheeOrg/Lychee-v3/wiki/Settings).
### Docker
Browse the [Docker Hub Registry](https://hub.docker.com/r/) for various automated Lychee-Docker builds.
Various docker builds include :
- [LinuxServer.io build](https://hub.docker.com/r/linuxserver/lychee/)
- [ARMHF based Linuxserver.io build](https://hub.docker.com/r/lsioarmhf/lychee/)
### 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 »](https://github.com/LycheeOrg/Lychee-v3/wiki/Plugins)
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 »](https://github.com/GustavePate/lycheesync) |
| lycheeupload | Upload photos to Lychee via SSH | [More »](https://github.com/r0x0r/lycheeupload) |
| Jekyll | Liquid tag for Jekyll sites that allows embedding Lychee albums | [More »](https://gist.github.com/tobru/9171700) |
| lychee-redirect (DEPRECATED) | Redirect from an album-name to a Lychee-album | [More »](https://github.com/electerious/lychee-redirect) |
| lychee-watermark (DEPRECATED) | Adds a second watermarked photo when uploading images | [More »](https://github.com/electerious/lychee-watermark) |
| lychee-rss | Creates a RSS-Feed out of your photos | [More »](https://github.com/cternes/Lychee-RSS) |
| lychee-FlashAir | Import from a Toshiba FlashAir WiFi SD card | [More »](https://github.com/mhp/Lychee-FlashAir) |
| lychee-webroot | Controls photos accessibility and keeps Lychee files hidden | [More »](https://github.com/Bramas/lychee-webroot) |
| lychee-create-medium | Generate missing medium size photos | [More »](https://github.com/Bramas/lychee-create-medium) |
## Troubleshooting
Take a look at the [FAQ](https://github.com/LycheeOrg/Lychee-v3/wiki/FAQ) if you have problems. Discovered a bug? Please create an issue here on GitHub!
## Thanks to our contributors
Tobias Reich
💻 📖 🐛 🎨
Benoît Viguier
💻 🐛 🎨 📖 🌍 👀
Ludovic Rousseau
💻 🐛 📖 ⚠️ 👀
Clément Lamoureux
💻
d7415
💻 🐛
Brian
💻 🐛
Hermann Käser
🐛 💻
Alicia
🌍
Peter Grassberger
📦
Herald Yu
🌍 🐛
arxcdr
🌍
jeyca
🐛
Milo Cesar
🌍
Ben Abbott
📖
Bish Erbas
🐛 💻
Elias
💻
Job Evers‐Meltzer
📦
Nemo
💻
Fly Man
💻 📖
Edouard Menayde
📖
Robbert
📖
James Webster
📖
Quentin Ligier
💻
Michael Procter
💻
Nils Asmussen
💻
cternes
💻
Candid Dauth
💻
Rouven Hurling
💻
Peter Hoffmann
💻
djdallmann
💻
Ricardo
💻
Powen Tan
💻
Renfred Harper
📦
dixy
💻
Felix Eckhofer
💻
Bocquet Aldric
💻
Matthias Gutjahr
💻
Quentin Bramas
💻
Ben Snider
💻
Joseph Pintozzi
💻
Rene Luria
💻
Nils Windisch
📖
Aron Brown
💻
Mathieu Leplatre
💻
Cronos87
💻
petter
🐛
Andi Machovec
🌍
mkiric
💻
Dmitry Krylov
💻
humantex
🐛
Guimik
🐛
colinmcglothlin
🐛
Tom Szilagyi
🐛
Andreas Schneider
🐛
fatherb
🐛
Luc Bonnefond
🐛
Sebastian Chrobak
🐛
Harri Häivälä
🐛
Carl
🐛
結城イヴ
🐛
Dirk
🐛
corrilan
🐛
Himself132
🐛
Samuel FORESTIER
📖
Daniel Swarbrick
🐛
Jonas
💻
capulo
🐛
ezek1el
🐛
anroth76
💻
Gabriel
🐛
dbw3
🐛
nemobis
📖
roblandry
🐛 💻 🚇
Michael Rasmussen
🐛 💻
kamil4
🐛 💻
rwa
💻 🐛
copperschnack
💻
Edoardo Grassi
🌍
Edward Betts
🌍
romansirokov
💻
yxhlcl
🐛 💻