Update readme.md
This commit is contained in:
Tobias Reich
parent
4d3fb39196
commit
b0dccfb3e0
166
readme.md
166
readme.md
@ -1,110 +1,58 @@
|
|||||||
# Lychee
|
# Lychee
|
||||||
|
|
||||||
#### A great looking and easy-to-use Photo-Management-System.
|
#### A great looking and easy-to-use Photo-Management-System.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Lychee is a free, easy to use and great looking photo-management-system you can run on your server to manage and share photos. Just download the source and follow the instructions to install Lychee wherever you want.
|
Lychee is a free, easy to use and great looking photo-management-system you can run on your server to manage and share photos. Just download the source and follow the instructions to install Lychee wherever you want.
|
||||||
|
|
||||||
## Installation
|
## 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:
|
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)
|
||||||
|
|
||||||
extension = php_mbstring.dll
extension = php_exif.dll
|
## How to use
|
||||||
extension = php_gd2.dll
|
|
||||||
|
After the configuration, navigate your browser to the place where Lychee is located. Everything should work now.
|
||||||
To use Lychee without restrictions, we recommend to increase the values of the following properties:
|
|
||||||
|
#### FTP Upload
|
||||||
upload_max_filesize = 100M
|
|
||||||
max_file_uploads = 100
post_max_size = 100M
|
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)
|
||||||
|
|
||||||
#### Folder permissions
|
#### Keyboard Shortcuts
|
||||||
|
|
||||||
Change the permissions of `uploads/` to 777, including all subfolders:
|
This shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](https://github.com/electerious/Lychee/wiki/Keyboard-Shortcuts)
|
||||||
|
|
||||||
chmod -R 777 uploads/
|
## Browser Support
|
||||||
|
|
||||||
#### Lychee configuration `php/config.php`
|
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.
|
||||||
|
|
||||||
Change the following properties with your MySQL information:
|
## Update
|
||||||
|
|
||||||
$db = The name of the Database you want to use
|
To update Lychee, simply replace all files, excluding the following ones:
|
||||||
-> 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)
|
`uploads/`, `php/config.php`
|
||||||
|
|
||||||
Your photos are protected by a username and password you need to set:
|
## Troubleshooting
|
||||||
|
|
||||||
$user = Your username for Lychee
|
If Lychee is not working properly, try to open `php/check.php`. This file will take a look at your configuration and displays all errors it can find. Everything should work if you can see the message "Lychee is ready!".
|
||||||
$password = Your password for Lychee
|
|
||||||
|
## About
|
||||||
This settings are optional and doesn't need to be changed:
|
|
||||||
|
Lychee is made by [Tobias Reich](http://electerious.com) (HTML, CSS, JS, Design, Website Design and Development) with the help of [Philipp Maurer](http://phinal.net) (PHP, MySQL).
|
||||||
$thumbQuality = Photo thumbs quality
|
|
||||||
-> Less means a inferiority quality of your thumbs, but faster loading
|
##License
|
||||||
-> More means a better quality of your thumbs, but slower loading
|
|
||||||
|
(MIT License)
|
||||||
$bitlyUsername = Bit.ly Username
$bitlyApi = Bit.ly API key
|
|
||||||
-> Lychee can generate short links if this properties are set
|
Copyright (C) 2013 [Tobias Reich](http://electerious.com)
|
||||||
|
Copyright (C) 2013 [Philipp Maurer](http://phinal.net)
|
||||||
## How to use
|
|
||||||
|
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:
|
||||||
After the configuration, navigate your browser to the place where Lychee is located. Everything should work now.
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
### FTP Upload
|
|
||||||
|
|
||||||
You can upload photos directly with every FTP client into Lychee. This feature helps you to share single images quickly with others.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
## Update
|
|
||||||
|
|
||||||
To update Lychee, simply replace all files, excluding the following ones:
|
|
||||||
`uploads/`, `php/config.php`
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
If Lychee is not working properly, try to open `php/check.php`. This file will take a look at your configuration and displays all errors it can find. Everything should work if you can see the message "Lychee is ready!".
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
Lychee is made by [Tobias Reich](http://electerious.com) (HTML, CSS, JS, Design, Website Design and Development) with the help of [Philipp Maurer](http://phinal.net) (PHP, MySQL).
|
|
||||||
|
|
||||||
##License
|
|
||||||
|
|
||||||
(MIT License)
|
|
||||||
|
|
||||||
Copyright (C) 2013 [Tobias Reich](http://electerious.com)
|
|
||||||
Copyright (C) 2013 [Philipp Maurer](http://phinal.net)
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user