lychee/README.md

77 lines
5.1 KiB
Markdown
Raw Normal View History

# Lychee
2015-05-24 19:50:08 +00:00
#### A great looking and easy-to-use photo-management-system.
2015-04-14 20:49:15 +00:00
![Lychee](http://l.electerious.com/uploads/big/c4b58cb87d95aeaed78fdca581cc908c.jpg)
![Lychee](http://l.electerious.com/uploads/big/075ac5de5b5d6c593acbb700f0e1d739.jpg)
2016-08-22 13:54:10 +00:00
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. Try the [Live Demo](http://ld.electerious.com) or read more on our [Website](http://lychee.electerious.com).
## Installation
2016-03-05 10:54:55 +00:00
To run Lychee, everything you need is a web-server with PHP 5.5 or later and a MySQL-Database. Follow the instructions to install Lychee on your server. [Installation »](docs/Installation.md)
## How to use
You can use Lychee right after the installation. Here are some advanced features to get the most out of it.
### Settings
2014-02-25 23:42:49 +00:00
Sign in and click the gear on 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 »](docs/Settings.md)
### Update
2014-02-25 23:42:49 +00:00
Updating is as easy as it should be. [Update »](docs/Update.md)
2014-02-23 15:59:45 +00:00
### Build
2014-02-25 23:42:49 +00:00
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 »](docs/Build.md)
2014-02-23 15:59:45 +00:00
### Keyboard Shortcuts
2013-10-17 21:07:09 +00:00
These shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](docs/Keyboard%20Shortcuts.md)
2013-10-17 21:07:09 +00:00
2014-02-23 21:42:15 +00:00
### Dropbox import
2014-03-17 08:16:32 +00:00
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](docs/Settings.md) of Lychee.
2014-02-23 21:42:15 +00:00
### Twitter Cards
2015-08-21 20:13:58 +00:00
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).
2014-10-12 10:11:38 +00:00
### Imagick
Lychee uses [Imagick](http://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](http://www.imagemagick.org) in [the settings](docs/Settings.md).
2015-11-14 12:09:21 +00:00
### Docker
Browse the [Docker Hub Registry](https://hub.docker.com/r/kdelfour/lychee-docker/) for various automated Lychee-Docker builds. We recommed to use [lychee-docker](https://hub.docker.com/r/kdelfour/lychee-docker/) by [kdelfour](https://github.com/kdelfour).
2014-04-22 10:11:48 +00:00
### Plugins and Extensions
2014-07-27 11:04:34 +00:00
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 »](docs/Plugins.md)
2014-04-22 10:11:48 +00:00
It's also possible to build extensions upon Lychee. The way to do so isn't documented and can change every time. We recommend to use the plugin-system, when possible.
2014-04-22 10:11:48 +00:00
Here's a list of all available Plugins and Extensions:
2013-10-27 12:24:57 +00:00
2014-02-25 16:08:37 +00:00
| Name | Description | |
2013-10-27 12:24:57 +00:00
|:-----------|:------------|:------------|
2014-02-25 16:08:37 +00:00
| lycheesync | Sync Lychee with any directory containing photos | [More »](https://github.com/GustavePate/lycheesync) |
2014-09-25 18:06:49 +00:00
| lycheeupload | Upload photos to Lychee via SSH | [More »](https://github.com/r0x0r/lycheeupload) |
2014-02-25 16:08:37 +00:00
| Jekyll | Liquid tag for Jekyll sites that allows embedding Lychee albums | [More »](https://gist.github.com/tobru/9171700) |
2014-04-01 18:19:37 +00:00
| lychee-redirect | Redirect from an album-name to a Lychee-album | [More »](https://github.com/electerious/lychee-redirect) |
2014-08-22 19:14:24 +00:00
| lychee-watermark | Adds a second watermarked photo when uploading images | [More »](https://github.com/electerious/lychee-watermark) |
2014-09-02 19:48:16 +00:00
| lychee-rss | Creates a RSS-Feed out of your photos | [More »](https://github.com/cternes/Lychee-RSS) |
2015-02-25 20:02:03 +00:00
| 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) |
2016-01-31 11:28:22 +00:00
| lychee-create-medium | Generate missing medium size photos | [More »](https://github.com/Bramas/lychee-create-medium) |
2013-10-05 13:42:37 +00:00
2014-04-22 10:11:48 +00:00
## Troubleshooting
Take a look at the [FAQ](docs/FAQ.md) if you have problems. Discovered a bug? Please create an issue here on GitHub!
2014-02-08 17:40:40 +00:00
## Donate
2016-08-22 13:54:10 +00:00
I am working hard on continuously developing and maintaining Lychee. Please consider making a donation via [Flattr](https://flattr.com/submit/auto?user_id=electerious&url=http%3A%2F%2Flychee.electerious.com&title=Lychee&category=software) or PayPal (from [our site](http://lychee.electerious.com/)) to keep the project going strong and me motivated.