readme.md 5.11 KB
Newer Older
Tobias Reich's avatar
Tobias Reich committed
1
2
3
4
# Lychee

#### A great looking and easy-to-use Photo-Management-System.

Tobias Reich's avatar
V2.0    
Tobias Reich committed
5
6
![Lychee](http://l.electerious.com/uploads/big/136b4779d133a94666d5f0d151b8ea2f.png)
![Lychee](http://l.electerious.com/uploads/big/580f1300f884c330fa34b652decb0571.png)
Tobias Reich's avatar
Tobias Reich committed
7

Tobias Reich's avatar
Tobias Reich committed
8
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://electerious.com/lychee_demo/) or read more on our [Website](http://lychee.electerious.com).
Tobias Reich's avatar
Tobias Reich committed
9
10
11

## Installation

Tobias Reich's avatar
Tobias Reich committed
12
To run Lychee, everything you need is a web-server with PHP 5.3 or later and a MySQL-Database. Follow the instructions to install Lychee on your server. [Installation »](docs/Installation.md)
Tobias Reich's avatar
Tobias Reich committed
13

Tobias Reich's avatar
V2.0    
Tobias Reich committed
14
## How to use
Tobias Reich's avatar
Tobias Reich committed
15

Tobias Reich's avatar
V2.0    
Tobias Reich committed
16
You can use Lychee right after the installation. Here are some advanced features to get the most out of it.
Tobias Reich's avatar
Tobias Reich committed
17

Tobias Reich's avatar
V2.0    
Tobias Reich committed
18
### Settings
Tobias Reich's avatar
Tobias Reich committed
19

Tobias Reich's avatar
Tobias Reich committed
20
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)
Tobias Reich's avatar
Tobias Reich committed
21

Tobias Reich's avatar
V2.0    
Tobias Reich committed
22
### Update
Tobias Reich's avatar
Tobias Reich committed
23

Tobias Reich's avatar
Tobias Reich committed
24
Updating is as easy as it should be.  [Update »](docs/Update.md)
Tobias Reich's avatar
Tobias Reich committed
25

Tobias Reich's avatar
Tobias Reich committed
26
27
### Build

Tobias Reich's avatar
Tobias Reich committed
28
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)
Tobias Reich's avatar
Tobias Reich committed
29

Tobias Reich's avatar
V2.0    
Tobias Reich committed
30
### Keyboard Shortcuts
Tobias Reich's avatar
Tobias Reich committed
31

Tobias Reich's avatar
Tobias Reich committed
32
These shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](docs/Keyboard Shortcuts.md)
Tobias Reich's avatar
Tobias Reich committed
33

Tobias Reich's avatar
Tobias Reich committed
34
35
### Dropbox import

nilswindisch's avatar
typo    
nilswindisch committed
36
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.
Tobias Reich's avatar
Tobias Reich committed
37

Tobias Reich's avatar
V2.0    
Tobias Reich committed
38
### Twitter Cards
Tobias Reich's avatar
Tobias Reich committed
39

Tobias Reich's avatar
V2.0    
Tobias Reich committed
40
Lychee supports [Twitter Cards](https://dev.twitter.com/docs/cards) and [Open Graph](http://opengraphprotocol.org) 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](https://dev.twitter.com/docs/cards/validation/validator).
Tobias Reich's avatar
Tobias Reich committed
41

42
### Plugins and Extensions
Tobias Reich's avatar
Tobias Reich committed
43

Tobias Reich's avatar
Tobias Reich committed
44
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)
45
46

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.
Tobias Reich's avatar
Tobias Reich committed
47

48
Here's a list of all available Plugins and Extensions:
Tobias Reich's avatar
Tobias Reich committed
49

Tobias Reich's avatar
Tobias Reich committed
50
| Name | Description | |
Tobias Reich's avatar
Tobias Reich committed
51
|:-----------|:------------|:------------|
Tobias Reich's avatar
Tobias Reich committed
52
53
| lycheesync | Sync Lychee with any directory containing photos | [More »](https://github.com/GustavePate/lycheesync) |
| Jekyll | Liquid tag for Jekyll sites that allows embedding Lychee albums | [More »](https://gist.github.com/tobru/9171700) |
Tobias Reich's avatar
Tobias Reich committed
54
| lychee-redirect | Redirect from an album-name to a Lychee-album | [More »](https://github.com/electerious/lychee-redirect) |
Tobias Reich's avatar
Tobias Reich committed
55
| lychee-watermark | Adds a second watermarked photo when uploading images | [More »](https://github.com/electerious/lychee-watermark) |
Tobias Reich's avatar
Tobias Reich committed
56

57
58
59
60
## Troubleshooting

Take a look at the [FAQ](docs/FAQ.md) if you have problems. Discovered a bug? Please create an issue here on GitHub!

Tobias Reich's avatar
V2.0    
Tobias Reich committed
61
## Developer
Tobias Reich's avatar
Tobias Reich committed
62
63
64
65
| Version | Name |
|:-----------|:------------|
| 1.2, 1.3, 2.x | [Tobias Reich](http://electerious.com)|
| 1.0, 1.1 | [Tobias Reich](http://electerious.com)<br>[Philipp Maurer](http://phinal.net) |
Tobias Reich's avatar
Tobias Reich committed
66

Tobias Reich's avatar
Tobias Reich committed
67
68
69
70
71
## Donate

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.

## License
Tobias Reich's avatar
Tobias Reich committed
72

Tobias Reich's avatar
Tobias Reich committed
73
(MIT License)
Tobias Reich's avatar
Tobias Reich committed
74

Tobias Reich's avatar
Tobias Reich committed
75
Copyright (C) 2014 [Tobias Reich](http://electerious.com)  
Tobias Reich's avatar
Tobias Reich committed
76

Tobias Reich's avatar
Tobias Reich committed
77
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Tobias Reich's avatar
Tobias Reich committed
78

Tobias Reich's avatar
Tobias Reich committed
79
80
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

nilswindisch's avatar
typo    
nilswindisch committed
81
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.