You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Lychee: A Stunning and User-Friendly Photo Management System
22
22
23
-
#### A great looking and easy-to-use photo-management-system.
23
+
Lychee is a free, open-source photo-management tool that runs on your server or web space. Installation is quick and easy, taking just seconds. With Lychee, you can upload, manage, and share your photos seamlessly, just like using a native application. It comes with all the essential features you need, ensuring your photos are stored securely. Read more on our [website](https://LycheeOrg.github.io).
24
24
25
-
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).
25
+
For even more advanced features, consider the Supporter Edition (SE). The SE version offers additional functionality to enhance your experience. Learn more about the Supporter Edition and its benefits [here](https://lycheeorg.github.io/get-supporter-edition).
26
26
27
-
## Notice: `master` & `alpha` branches
28
-
29
-
As LycheeOrg is a very small team, we do not have many maintainers. Most of us have an active work/family life, and as a result, it is no longer possible for us to apply proper 4-eyes principle in the coding reviews.
27
+
## Support the Team
30
28
31
-
In order to keep our high code quality, the following changes have been applied.
32
-
33
-
-`master` stays as a stable branch and contains 4-eyes peer-reviewed pull-requests.
34
-
-`alpha` contains the latest changes (i.e. the above mentionned PR) merged with minimal review.
29
+
We aim to maintain a free open-source photography library with high quality of code.<br>
30
+
Being in control of our own data, our own pictures is something that we value above all.
35
31
36
-
With this change, we hope to strike a balance between decently paced development (on `alpha`) and maintaining a robust core (on `master`).
32
+
Through [contributions, donations, and sponsorship](https://github.com/sponsors/LycheeOrg), you allow Lychee to thrive. Your donations directly support demo server costs, continuous enhancements, and most importantly bug fixes!
37
33
38
-
On Docker, `nightly`/`dev` continues to refer to the latest `master` commit.
39
-
The `alpha` tag is updated daily with the content of the associated branch.
34
+
## Installation
40
35
41
-
That being said, if you like the gallery and would like to contribute, do not hesitate to open pull request. If you would like to see more functionalities added and help us push Lychee, [Join the team!](https://lycheeorg.github.io/docs/contributions.html#joining-the-team)
36
+
There are three deployment options available. The simplest is **Docker deployment**, as all dependencies are already predefined and configured.
42
37
43
-
### Support the Team
38
+
### Docker deployment
44
39
45
-
We aim to maintain a free open-source photography library with high quality of code.<br>
46
-
Being in control of our own data, our own pictures is something that we value above all.
40
+
An official Docker image can be found at [LycheeOrg/Lychee-Docker](https://github.com/LycheeOrg/Lychee-Docker) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee).
47
41
48
-
Through [contributions, donations, and sponsorship](https://github.com/sponsors/LycheeOrg), you allow Lychee to thrive. Your donations directly support demo server costs, continuous enhancements, and most importantly bug fixes!
42
+
### File-based deployment
49
43
44
+
Copy the extracted Zip file from https://github.com/LycheeOrg/Lychee/releases to your webserver
50
45
51
-
##Installation
46
+
### Build from Source deployment
52
47
53
48
To run Lychee, everything you need is a web-server with PHP 8.2 or later and a database (MySQL/MariaDB, PostgreSQL or SQLite). Follow the instructions to install Lychee on your server. This version of Lychee is built on the Laravel framework. To install:
54
49
@@ -62,26 +57,22 @@ To run Lychee, everything you need is a web-server with PHP 8.2 or later and a d
62
57
63
58
See detailed instructions on the [Installation](https://lycheeorg.github.io/docs/installation.html) page of our documentation.
64
59
65
-
### Docker
66
-
67
-
Alternatively, an official Docker image can be found at [LycheeOrg/Lychee-Docker](https://github.com/LycheeOrg/Lychee-Docker) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee).
68
-
69
60
### Update
70
61
71
-
Updating is as easy as it should be. [Update »](https://lycheeorg.github.io/docs/update.html)
62
+
Updating is as easy as it should be. [Update »](https://lycheeorg.github.io/docs/update.html)
63
+
64
+
## Configuration
72
65
73
66
### Settings
74
67
75
68
Sign in and click the gear in the top left corner to change your settings. [Settings »][1]
76
69
77
-
### Build
78
-
79
-
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-front](https://github.com/LycheeOrg/Lychee-front). [Build »](https://lycheeorg.github.io/docs/frontend.html)
80
-
81
-
## Advanced Features
70
+
### Advanced Features
82
71
83
72
Lychee is ready to use straight after installation, but some features require a little more configuration.
84
73
74
+
## Documentation
75
+
85
76
### Keyboard Shortcuts
86
77
87
78
These shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](https://lycheeorg.github.io/docs/keyboard.html)
@@ -102,15 +93,25 @@ Lychee uses [ImageMagick](https://www.imagemagick.org) when installed on your se
102
93
103
94
In order to use the new photos email notification you will need to have configured the **MAIL_** variables in your .env to your mail provider & [setup cron](https://laravel.com/docs/scheduling#running-the-scheduler). Once that is complete you then toggle **Send new photos notification emails** in the [settings][1]. Your users will be able to opt-in to the email notifications by entering their email address in the **Notifications** setting in the sidebar. Photo notifications will be grouped and sent out once a week to the site admin, album owner & anyone who the album is shared with, if their email has been added. The admin or user who added the photo to an album, will not receive a email notification for the photos they added.
104
95
105
-
## Customizing
96
+
## Troubleshooting
106
97
107
-
You can customize lychee with your own css code. Here you can find a list of available themes.
98
+
Take a look at the [Documentation](https://lycheeorg.github.io/docs/), particularly the [FAQ](https://lycheeorg.github.io/docs/faq_troubleshooting.html) if you have problems. Discovered a bug? Please create an issue [here](https://github.com/LycheeOrg/Lychee/issues) on GitHub! You can also contact us directly on [gitter (login with your github account)](https://gitter.im/LycheeOrg/Lobby) or on [discord »][discord].
As LycheeOrg is a very small team, we do not have many maintainers. Most of us have an active work/family life, and as a result, it is no longer possible for us to apply proper 4-eyes principle in the coding reviews.
112
103
113
-
Take a look at the [Documentation](https://lycheeorg.github.io/docs/), particularly the [FAQ](https://lycheeorg.github.io/docs/faq_troubleshooting.html) if you have problems. Discovered a bug? Please create an issue [here](https://github.com/LycheeOrg/Lychee/issues) on GitHub! You can also contact us directly on [gitter (login with your github account)](https://gitter.im/LycheeOrg/Lobby) or on [discord »][discord].
104
+
In order to keep our high code quality, the following changes have been applied.
105
+
106
+
-`master` stays as a stable branch and contains 4-eyes peer-reviewed pull-requests.
107
+
-`alpha` contains the latest changes (i.e. the above mentionned PR) merged with minimal review.
108
+
109
+
With this change, we hope to strike a balance between decently paced development (on `alpha`) and maintaining a robust core (on `master`).
110
+
111
+
On Docker, `nightly`/`dev` continues to refer to the latest `master` commit.
112
+
The `alpha` tag is updated daily with the content of the associated branch.
113
+
114
+
That being said, if you like the gallery and would like to contribute, do not hesitate to open pull request. If you would like to see more functionalities added and help us push Lychee, [Join the team!](https://lycheeorg.github.io/docs/contributions.html#joining-the-team)
114
115
115
116
## Open Source Community Support
116
117
@@ -130,10 +131,9 @@ We would like to thank Jetbrains for supporting us with their [Open Source Devel
0 commit comments