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
Copy file name to clipboardExpand all lines: README.md
+65-75Lines changed: 65 additions & 75 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,94 +35,84 @@ Through [contributions, donations, and sponsorship](https://github.com/sponsors/
35
35
36
36
## Contributing
37
37
38
-
Want to help improve Lychee? We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.
39
-
40
-
Check out our [Contribution Guide](docs/Contribute.md) to get started with:
41
-
- Setting up your development environment
42
-
- Understanding our coding standards
43
-
- Running tests and quality checks
44
-
- Submitting pull requests
38
+
Contributions welcome! Check out our [Contribution Guide](docs/Contribute.md) and [documentation](https://github.com/LycheeOrg/Lychee/tree/master/docs) for setup, coding standards, and PR guidelines.
45
39
46
40
## Installation
47
41
48
-
There are three deployment options available. The simplest is **Docker deployment**, as all dependencies are already predefined and configured.
49
-
50
-
### Docker deployment
51
-
52
-
An official Docker image can be found at [LycheeOrg/Lychee](https://github.com/LycheeOrg/Lychee/pkgs/container/lychee) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee).
53
-
54
-
### File-based deployment
55
-
56
-
Copy the extracted Zip file from https://github.com/LycheeOrg/Lychee/releases to your webserver.
57
-
58
-
If you feel like checking the authenticity of our releases, we advise you to read our [Verifying Releases documentation »](docs/specs/5-operations/verifying-releases.md).
59
-
60
-
### Build from Source deployment
61
-
62
-
To run Lychee, everything you need is a web-server with PHP 8.4 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:
63
-
64
-
1. Clone this repo to your server and set the web root to `lychee/public`
65
-
2. Run `composer install --no-dev` to install dependencies
66
-
3. Run `npm install` to install node dependencies
67
-
4. Run `npm run build` to build the front-end
68
-
5. Copy `.env.example` as `.env` and edit it to match your parameters
69
-
6. Generate your secret key with `php artisan key:generate`
70
-
7. Migrate your database with `php artisan migrate` to create a new database or migrate an existing Lychee installation to the latest framework.
71
-
72
-
See detailed instructions on the [Installation »](https://lycheeorg.dev/docs/installation.html) page of our documentation.
73
-
74
-
### Update
75
-
76
-
Updating is as easy as it should be. [Update »](https://lycheeorg.dev/docs/update.html)
77
-
78
-
## Configuration
79
-
80
-
### Settings
81
-
82
-
Sign in and click the gear in the top left corner to change your settings. [Settings »][1]
83
-
84
-
### Advanced Features
85
-
86
-
Lychee is ready to use straight after installation, but some features require a little more configuration.
87
-
88
-
## Documentation
89
-
90
-
### Keyboard Shortcuts
91
-
92
-
These shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](https://lycheeorg.dev/docs/keyboard.html)
93
-
94
-
### Dropbox import
95
-
96
-
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/saver). 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][1] of Lychee.
97
-
98
-
### Twitter Cards
99
-
100
-
Lychee supports [Twitter Cards](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-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 [Twitter's Card Validator](https://cards-dev.twitter.com/validator).
101
-
102
-
### ImageMagick
103
-
104
-
Lychee uses [ImageMagick](https://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 [ImageMagick](https://www.imagemagick.org) in the [settings][1].
105
-
106
-
### New Photos Email Notification
107
-
108
-
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.
42
+
### Docker (Recommended)
43
+
44
+
The easiest way to deploy Lychee with all dependencies configured:
- **Pre-built releases:** Download from [GitHub Releases](https://github.com/LycheeOrg/Lychee/releases)
100
+
- **From source:** Requires PHP 8.4+, Composer, and npm
101
+
102
+
For detailed installation, configuration, and update instructions, see our **[Documentation](https://lycheeorg.dev/docs/)**.
109
103
110
104
## Troubleshooting
111
105
112
-
Take a look at the [Documentation](https://lycheeorg.dev/docs/), particularly the [FAQ](https://lycheeorg.dev/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].
113
-
114
-
On Docker, `edge` is used to refer to the latest `master` commit.
115
-
And `latest` is used to refer to the latest stable release.
116
-
117
-
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.dev/docs/contributions.html#joining-the-team)
106
+
- **[Documentation](https://lycheeorg.dev/docs/)** - Complete guides and FAQ
0 commit comments