diff --git a/docs/installation.md b/docs/installation.md index e229b2d1..92c43419 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -40,7 +40,7 @@ The Lychee gallery has a few system requirements. You will need to make sure you - Optionally, you can also install the following command line tools: - Exiftool (for better handling of EXIF metadata) - FFmpeg (to generate video thumbnails) -- To install from git you will also need Composer. See [below](#from-the-master-branch) for details. +- To install from git you will also need Composer and npm. See [below](#from-the-master-branch) for details. While Lychee works on 32bit systems, we **strongly** recommend the use of a 64bit OS. @@ -59,7 +59,7 @@ It contains a trimmed down version of the Lychee files. #### From the Master branch -Lychee utilizes [Composer][1] to manage its dependencies. Make sure you have Composer installed on your machine. +Lychee utilizes [Composer][1] to manage its php dependencies and [npm][2] for its front-end. Make sure you have both installed on your machine. ```bash git clone https://www.github.com/LycheeOrg/Lychee /var/www/html/Lychee @@ -71,8 +71,10 @@ cd /var/www/html/Lychee Install the required dependencies. ```bash composer install --no-dev +npm install +npm run build ``` -If you want to help develop Lychee, install the development dependencies by removing the `--no-dev` or replacing it with `--dev`. +If you want to help develop Lychee, install the development dependencies by removing the `--no-dev` and use `npm run dev` to have change monitoring on the front-end. ### Configuration @@ -230,3 +232,4 @@ server { [1]: https://getcomposer.org/ +[2]: https://nodejs.org/ \ No newline at end of file diff --git a/docs/releases.md b/docs/releases.md index 33e5014e..87dde237 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -28,6 +28,96 @@ } +## Version 5 + +### v5.0.0 + +Released on Dec 25, 2023 + +#### BREAKING CHANGE IN BUILD STEPS + +If you are using `git clone`, you will need to use `npm` to build the front-end: + +1. `composer install --no-dev` +2. `php artisan migrate` +3. `npm install` +4. `npm run build` + +Those files are however provided in the release zip file. + +#### Changes from v4.13.0 + +* `new` #2031 : improved honeypot logic & add more honey by @ildyria. +* `new` #2033 : map providers are now specified in an Enum by @ildyria. +* `fixes` #2041 : Delete existing user permissions associated by @ildyria. +* `new` #2066 : Add optimize database call by @ildyria. +* `fixes` #2069 : Adds missing space separator in Ghostbuster command advice by @HorlogeSkynet. +* `new` #2071 : Drops support for singular public photos in search. by @ildyria. +* `new` #2060 : Bye bye PHP 8.1, long live PHP 8.2 by @ildyria. +* `new` #2072 : Add configuration check between int and positive (>0) by @ildyria. + +#### Changes included in the new Front-end + +* `fixes` [♯199](https://github.com/LycheeOrg/Lychee-front/issues/199) : Depreciated dependencies cries for a new frontend. #199 + > Complete rewrite of the front-end using latest technologies. Moving to a TALL stack: Tailwind, Alpinejs, Livewire, Laravel. +* `new` #12 : Shared albums: policy + > Complete new implementation of sharing and access rights. +* `new` #383 : Allow other users to upload to shared albums + > See #12 +* `new` #725 : Login on direct album url if not logged in and album needs it + > Proper implementation with the new frontend +* `new` #748 : UI/UX: give more information about the capabilities given to new users in the users page +* `fixes` #828 : Album name not correct displayed in confirmation popup when moving a newly created album +* `new` #857 : Support for very large uploads by chunking +* `fixes` #1053 : Public album is not and can not be configured to be public #1053 + > **BREAKING CHANGE**: The _public_ smart album has been removed. Pictures are no longer made public singular. +* `new` #1211 : Date/Time display options + > Date/Time format are now configurable in the settings per location (sidebar, panel etc.) +* `new` #1249 : header text for the gallery + > Description of each album is directly readable at the top and support markdown. +* `new` #1189 : Multiline descriptions with markdown support for images and albums + > Similar functionalities have been added for pictures too. +* `new` #1253 : Change album's Top Right menu behavior when selecting some pictures + > Top right action menu behaviour has enhanced to increase visibility and intent in the album view. + > It now depends of the selected elements. +* `new` #1462 : Access Rights management: Users and Albums + > Major refactoring the access rights, user can now give read, upload, edit, delete access to others. +* `fixes` #1676 : Unable to open sidebar, can't navigate away from log/diagnostic/setting page +* `new` #1704 : Add real links to albums + > No longer use fragments, as a results links are properly clickable. +* `fixes` #1720 : Download button is visible and does not support download rights yet. +* `fixes` #1732 : Consistent URLs when Landing Page is disabled. + > url have been made consisten accross the board. +* `fixes` #1744 : UX broken on version 4.7.0 for Safari iPhone + > New front-end will need more testing. +* `new` #1825 : Change accent color + > With the use of tailwindcss this is now easier to produce. +* `new` #1891 : Login popup appears if no albums created +* `fixes` #1948 : Internal server error on photo upload (permissions?) + > No longer applicable due to new front-end +* `fixes` #1973 : The CSS tweaks to disable auto zoom in/out no longer work #1973 + > No longer applicable due to new front-end +* `new` #1989 : Add search / filter for 'Move' destination album list +* `new` #2011 : Album Delete Confirmation + > deletion is now hidden in a danger zone. +* `fixes` #2050 : When trying to open a password protected shared album, no password prompt is shown +* `fixes` #2051 : Photo Download not work - UnauthorizedException +* `fixes` #2058 : Insufficient privilieges when opening the "Share album" dialog as a regular user +* `fixes` #2068 : Album allow public upload but disallow deletion + > Part of this is now available, user can give upload access to other users while preventing deletion. + The public part is not taken in consideration as this is too much of a security risk. +* `new` [♯104](https://github.com/LycheeOrg/Lychee-front/issues/104) : Rework Sharing Dialog in Settings + > Sharing page only provide an overview, sharing is now done at the album level. +* `new` [♯166](https://github.com/LycheeOrg/Lychee-front/issues/166) : Add album description between the header and the pictures +* `new` [♯268](https://github.com/LycheeOrg/Lychee-front/issues/268) : Css is too complex to permit anyone to create new theme + > We now use tailwindcss, which makes it easier to create a unified theme. +* `new` [♯312](https://github.com/LycheeOrg/Lychee-front/issues/312) : Make login dialog more prominent, auto-show login dialog if necessary, hide empty smart folders for anonymous users +* `fixes` [♯343](https://github.com/LycheeOrg/Lychee-front/issues/343) : Use proper URL instead of # fragments. +* `fixes` [♯344](https://github.com/LycheeOrg/Lychee-front/issues/344) : a are now correct links/interactive +* `fixes` [♯373](https://github.com/LycheeOrg/Lychee-front/issues/373) : Left menu is now working correctly +* `new` #2078 : Diagnostics: Info are displayed in blue by @ildyria +* `new` #2079 : Add option for thumbs overlay: none|hidden|always by @ildyria + ## Version 4 ### v4.13.0