arno/lychee
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Tobias Reich 2013-06-09 23:55:30 +03:00
parent 4d3fb39196
commit b0dccfb3e0
1 changed files with 57 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
readme.md
View File

@ -9,79 +9,27 @@ Lychee is a free, easy to use and great looking photo-management-system you can
## Installation
To run Lychee, everything you need is a web-server with PHP 5.3 or later and a MySQL-Database.
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 »](https://github.com/electerious/Lychee/wiki/Installation)
#### PHP configuration `php.ini`
## Settings
The following extensions must be activated:
extension = php_mbstring.dll extension = php_exif.dll
extension = php_gd2.dll
To use Lychee without restrictions, we recommend to increase the values of the following properties:
upload_max_filesize = 100M
max_file_uploads = 100 post_max_size = 100M
#### Folder permissions
Change the permissions of `uploads/` to 777, including all subfolders:
chmod -R 777 uploads/
#### Lychee configuration `php/config.php`
Change the following properties with your MySQL information:
$db = The name of the Database you want to use
-> Lychee will create the Database and Tables for you $dbUser = Your MySQL username $dbPassword = Your MySQL password $dbHost = Your MySQL host (in most cases you can use localhost)
Your photos are protected by a username and password you need to set:
$user = Your username for Lychee
$password = Your password for Lychee
This settings are optional and doesn't need to be changed:
$thumbQuality = Photo thumbs quality
-> Less means a inferiority quality of your thumbs, but faster loading
-> More means a better quality of your thumbs, but slower loading
$bitlyUsername = Bit.ly Username $bitlyApi = Bit.ly API key
-> Lychee can generate short links if this properties are set
Settings are located inside the `php/config.php`. All settings are optional and doesn't need to be changed. [Settings »](https://github.com/electerious/Lychee/wiki/Settings)
## How to use
After the configuration, navigate your browser to the place where Lychee is located. Everything should work now.
### FTP Upload
#### FTP Upload
You can upload photos directly with every FTP client into Lychee. This feature helps you to share single images quickly with others.
You can upload photos directly with every FTP client into Lychee. This feature helps you to share single images quickly with others. [FTP Upload »](https://github.com/electerious/Lychee/wiki/FTP-Upload)
1. Upload an image to `uploads/import/`
2. Navigate your browser to the place where Lychee is located (e.g. `http://example.com/view.php?p=filename.png`). `filename.png` must be replaced by the filename of your uploaded file.
3. Share the link.
#### Keyboard Shortcuts
Lychee will import the file as an public image, delete the original (unused) file and show it in the browser. [Sample FTP configuration](http://l.electerious.com/view.php?p=13657692738813).
### Keyboard Shortcuts
######Everywhere
`n` New album/photo
`u` Upload photo
`esc` Close/Back
######Photoview
`s` Star photo
`i` Show information
`f` Show photo in new tab
`backspace` Delete photo
`left` Previous photo
`right` Next photo
This shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](https://github.com/electerious/Lychee/wiki/Keyboard-Shortcuts)
## Browser Support
Lychee supports the latest versions of Google Chrome, Apple Safari and Mozilla Firefox. Photos you share with others can be viewed from every browser.
Lychee supports the latest versions of Google Chrome, Apple Safari and Mozilla Firefox. Photos you share with others can be viewed from every browser. For the best experience we are recommending to use Google Chrome or Apple Safari.
## Update