Improve documentation (#176)

ildyria · web-flow · commit 360a2c2dcdba · 2025-01-19T18:42:29.000+01:00
diff --git a/docs/api.md b/docs/api.md
@@ -6,9 +6,11 @@
 The current API provide the following entry points:
 See:
 
-- [routes/web.php](https://github.com/LycheeOrg/Lychee/blob/master/routes/web.php)
-- [routes/admin.php](https://github.com/LycheeOrg/Lychee/blob/master/routes/admin.php)
+- [routes/api_v2.php](https://github.com/LycheeOrg/Lychee/blob/master/routes/api_v2.php)
+- [routes/web-admin-v2.php](https://github.com/LycheeOrg/Lychee/blob/master/routes/web-admin-v2.php)
+- [routes/web_v2.php](https://github.com/LycheeOrg/Lychee/blob/master/routes/web_v2.php)
 
 Note that for all request, **'Accept: application/json' is mandatory** and that without mention of the contrary **'Content-Type: application/json' is also mandatory**.
 
-As of version 4.8.1, the api documentation is moved directly inside your own Lychee instance. It is accessible at the url `https://yourLycheeInstance.org/docs/api`.
+As of version 4.8.1, the api documentation is moved directly inside your own Lychee instance. It is accessible at the url `https://yourLycheeInstance.org/docs/api`.
+It is also possible to see it on our demo website: [https://lychee-demo.fly.dev/docs/api](https://lychee-demo.fly.dev/docs/api)
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -1,7 +1,7 @@
 ## Introduction
 
 Lychee's core configuration is managed using a `.env` file. It probably exists already in your directory, but if not it can be created by copying `.env.example`. The options which are already included in the `.env` file should be sufficient to cover the necessary configuration for the vast majority of all use-cases and setups. Using other options than those included in the `.env` file should rarely be necessary. However, this page contains a more complete list of the available options, incl. some highly advanced ones, together with descriptions and default values.
-For non-core options (for example UI options), take a look at [Settings](https://lycheeorg.github.io/docs/settings.html).
+For non-core options (for example UI options), take a look at [Settings](https://lycheeorg.dev/docs/settings.html).
 
 ### Base options
 
diff --git a/docs/contributions.md b/docs/contributions.md
@@ -8,7 +8,7 @@ Remember, bug reports are created in the hope that others with the same problem
 
 ## Support Questions
 
-Lychee's GitHub issue trackers are not intended to provide Lychee help or support. Please instead create a discussion [here][3] or contact us directly on [gitter][2].
+Lychee's GitHub issue trackers are not intended to provide Lychee help or support. Please instead create a discussion [here][3] or contact us directly on [discord][2].
 
 ## Security Vulnerabilities
 
@@ -21,7 +21,7 @@ Those are the versions in which we accept vulnerability reports.
 | latest release | &#10004;  |
 | < 5.0          | &#10005;  |
 
-If you discover a security vulnerability within Lychee, please contact us directly on [Gitter][2]. All security vulnerabilities will be promptly addressed.
+If you discover a security vulnerability within Lychee, please contact us directly on [Discord][2]. All security vulnerabilities will be promptly addressed.
 
 ## Core Development Discussion
 
@@ -31,10 +31,14 @@ You may propose new features or improvements to existing Lychee behavior in the
 
 You would like to support Lychee and help us push it further? Join the team!
 Your passion for Lychee will be measured by how active you are on the project.
-A minimum of three pull requests merged is to be expected before receiving the invitation.
-However, exceptions may apply (e.g., if you want to rewrite 100% of the front-end to VueJS).
+We are looking for people who are willing to help us maintain the project,
+review pull requests, and fix bugs.
 
-Contact us on [Gitter][2] if you would like to know more! :)
+If you would like to just do code review, that's fine too!
+We are always looking for more eyes on the code to ensure its quality.
+We will need your github handle to add you to the reviewer team.
+
+Contact us on [Discord][2]  if you would like to know more! :)
 
 ## How to properly submit a pull-request to Lychee?
 
@@ -185,7 +189,7 @@ The Lychee code of conduct is the same as Laravel's code of conduct:
 
 
 [1]: https://github.com/LycheeOrg/Lychee/issues
-[2]: https://gitter.im/LycheeOrg/Lobby
+[2]: https://discord.gg/JMPvuRQcTf
 [3]: https://github.com/LycheeOrg/Lychee/discussions
 [4]: https://github.com/LycheeOrg/Lychee/pulls
 
diff --git a/docs/docker.md b/docs/docker.md
@@ -84,7 +84,7 @@ Some variables are specific to Docker, and the default values are :
 
 ## Advanced configuration
 
-Note that nginx will accept by default images up to 100MB (`client_max_body_size 100M`) and that PHP parameters are overridden according to the [recommendations of the Lychee FAQ](https://lycheeorg.github.io/docs/faq_troubleshooting.html#i-cant-upload-large-photos).
+Note that nginx will accept by default images up to 100MB (`client_max_body_size 100M`) and that PHP parameters are overridden according to the [recommendations of the Lychee FAQ](https://lycheeorg.dev/docs/faq_troubleshooting.html#i-cant-upload-large-photos).
 
 You may still want to further customize PHP configuration. The first method is to mount a custom `php.ini` to `/etc/php/7.4/fpm/php.ini` when starting the container. However, this method is kind of brutal as it will override all parameters. It will also need to be remapped whenever an image is released with a new version of PHP.
 
diff --git a/docs/faq_general.md b/docs/faq_general.md
@@ -16,7 +16,7 @@ Take a look at the [Release Notes](releases.html) to see what's new.
 
 ### How can I easily contact the LycheeOrg organization?
 
-There is a Gitter associated with the project, feel free to join us there: https://gitter.im/LycheeOrg/Lobby
+There is a discord associated with the project, feel free to join us there: https://discord.gg/JMPvuRQcTf
 
 ### How can I set thumbnails for my albums?
 
@@ -33,7 +33,7 @@ Either press `n` (as **N**ew) or use the add menu.
 In order to bypass the CSRF protection, you can set up the `api_key` setting to a secret value and send that value over in the `Authorization` header.  
 Note that `api_key` only disables the CSRF protection, you still need to authenticate to the server.
 
-In order to authenticate, use [Session::login](https://lycheeorg.github.io/docs/api.html#apisessionlogin) and pass the returned `lychee_session` cookie to all subsequent requests.
+In order to authenticate, use [Session::login](https://lycheeorg.dev/docs/api.html#apisessionlogin) and pass the returned `lychee_session` cookie to all subsequent requests.
 
 The related code is available [here](https://github.com/LycheeOrg/Lychee/blob/master/app/Http/Middleware/VerifyCsrfToken.php#L55)
 
diff --git a/docs/installation.md b/docs/installation.md
@@ -9,7 +9,7 @@ The Lychee gallery has a few system requirements. You will need to make sure you
 	- MySQL _(version > 5.7.8)_ / MariaDB _(version > 10.2)_
 	- PostgreSQL _(version > 9.2)_
 	- Lychee's inbuilt SQLite3 support
-- PHP >= 8.2 with these PHP extensions:
+- PHP >= 8.3 with these PHP extensions:
 	- bcmath
 	- ctype
 	- dom
@@ -91,7 +91,7 @@ Note that there are up to three OS users which need to be taken into considerati
    For example, Apache executes the PHP interpreter as part of its own process if the extension `mod_php` is used.
    In case PHP FPM is used, for most distributions PHP FPM or CGI ships with a sensible default configuration which ensures that the PHP user is the same as the Web user.
    In both cases the PHP user is not of concern.
-   However, we are at least aware of one exception to this rule for Nginx on Fedora, see [FAQ](https://lycheeorg.github.io/docs/faq_troubleshooting.html#i-know-my-file-permissions-for-storage-bootstrapcache-publicuploads-and-publicdist-are-correct-and-accessible-by-my-web-server-user-but-im-still-getting-a-php-error-when-writing-to-any-of-these-directories)
+   However, we are at least aware of one exception to this rule for Nginx on Fedora, see [FAQ](https://lycheeorg.dev/docs/faq_troubleshooting.html#i-know-my-file-permissions-for-storage-bootstrapcache-publicuploads-and-publicdist-are-correct-and-accessible-by-my-web-server-user-but-im-still-getting-a-php-error-when-writing-to-any-of-these-directories)
  - The user which you use for shell logins and to run scripts; called the **CLI user** in the following.
    This user may be of particular concern, if you are planning to upload photos via the web interface _and_ import photos via the shell scripts.
 
@@ -160,7 +160,7 @@ It is also strongly recommended to serve Lychee over TLS. You may wish to consid
 
 Lychee includes a `public/.htaccess` file that is used to provide URLs without the `index.php` front controller in the path. Before serving Lychee with Apache, be sure to enable the `mod_rewrite` module so the `.htaccess` file will be honored by the server.
 
-Also check the Apache [upgrade instructions](https://lycheeorg.github.io/docs/upgrade.html#using-apache) for required permissions in your /etc/apache2/sites-available/example.com.conf file.
+Also check the Apache [upgrade instructions](https://lycheeorg.dev/docs/upgrade.html#using-apache) for required permissions in your /etc/apache2/sites-available/example.com.conf file.
 
 If the `.htaccess` file that ships with Lychee does not work with your Apache installation, try this alternative:
 
@@ -179,7 +179,7 @@ RewriteRule ^ index.php [L]
 ### nginx
 
 This is a sample nginx server block. It does not include TLS, but covers the Lychee-specific requirements.
-If you would like to serve from a subdirectory, take a look at [the FAQ](https://lycheeorg.github.io/docs/faq_installation.html#can-i-host-lychee-with-a-subpath-with-nginx-like-httpsexampledevlychee).
+If you would like to serve from a subdirectory, take a look at [the FAQ](https://lycheeorg.dev/docs/faq_installation.html#can-i-host-lychee-with-a-subpath-with-nginx-like-httpsexampledevlychee).
 
 ```nginx
 server {
@@ -205,7 +205,7 @@ server {
         fastcgi_param HTTP_PROXY "";
 
         ######### Make sure this is the correct socket for your system
-        fastcgi_pass unix:/run/php/php8.2-fpm.sock;
+        fastcgi_pass unix:/run/php/php8.3-fpm.sock;
         fastcgi_index index.php;
         ######## You may need to replace $document_root with the absolute path to your public folder.
         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
diff --git a/docs/releases.md b/docs/releases.md
@@ -88,7 +88,7 @@ Released on Nov 27, 2024
   > Bug introduced by the new timeline layout that was only affecting the photo layout when the absence of border was set in Lychee SE
 * `new` #2749 : Create automated signed releases by @ildyria.
   > We use [cosign](https://github.com/sigstore/cosign) to generate signed releases.
-  > The public key is available here: [lychee-cosign.pub](https://lycheeorg.github.io/lychee-cosign.pub).
+  > The public key is available here: [lychee-cosign.pub](https://lycheeorg.dev/lychee-cosign.pub).
 * `fixes` #2753 : ListAlbum fix by @ildyria.
   > When using extremely long albums names, the limiting of strings were getting negative length.
   > This resulted in error 500 when fetching the list of target albums.
@@ -189,11 +189,11 @@ For more context on those changes, see our blog posts:
 
 #### Introducing Lychee SE
 
-For the past few years, Lychee has been developed by a [small group of people](https://lycheeorg.github.io/support/) who have been working on it in their free time. We are proud to offer this software for free and we will continue to do so. However with time our team has decreased to the point where maintaining Lychee has become a challenge. We have been thinking about ways to keep Lychee alive, to be able to keep providing support, and to add more features.
+For the past few years, Lychee has been developed by a [small group of people](https://lycheeorg.dev/support/) who have been working on it in their free time. We are proud to offer this software for free and we will continue to do so. However with time our team has decreased to the point where maintaining Lychee has become a challenge. We have been thinking about ways to keep Lychee alive, to be able to keep providing support, and to add more features.
 
 We have come to the conclusion that we need to add a sponsor tier system. We have extended Lychee with a new version called SE (Supporter Edition) which will be available for our GitHub supporters. This SE version comes with enhanced features and configurations, helping us fund ongoing improvements while offering a bit extra to our supporters. The free version of Lychee will continue to be available but with a more streamlined feature set.
 
-We strongly encourage you to check the full comparison between the [free and supporter edition](https://lycheeorg.github.io/get-supporter-edition).  
+We strongly encourage you to check the full comparison between the [free and supporter edition](https://lycheeorg.dev/get-supporter-edition).  
 If you enjoy using Lychee, please consider [supporting us](https://github.com/sponsors/LycheeOrg).
 
 Thank you for helping us keep Lychee alive and growing!
@@ -905,7 +905,7 @@ Released on Jan 4, 2023
   > This reduces the risk of bugs.
 * `rm` #1673 : Nuke demo generator, does not reflect the latest version by @ildyria
   > This removes the /demo page which was used to generate AJAX response in order to mock a
-  > server response on the [demo](https://lycheeorg.github.io/demo/) page of Lychee.
+  > server response on the [demo](https://lychee-demo.fly.dev/) page of Lychee.
 * `new` #1671 : Ensure php version is correct prior migrations by @ildyria
   > Before running any migration, we are not verifying that the required minimum version of PHP is used.
 * `fixes` #1684 : Fix on HasAdminUser by @ildyria
@@ -1028,7 +1028,7 @@ Released on Aug 07, 2022
 - The internal representation of Albums changed with version 4.5.0.  
 We strongly recommend that you **BACK UP YOUR DATABASE BEFORE UPDATING**.
 - The folder structure changed for images; **please check the required directory permissions**.  
-Read more [here  &#187;](https://lycheeorg.github.io/docs/#directory-permissions).
+Read more [here  &#187;](https://lycheeorg.dev/docs/#directory-permissions).
 
 #### Changes
 
@@ -1555,7 +1555,7 @@ Nothing major here. Just a bunch of small bug fixes
 
 **WARNING**: Lychee now requires PHP 7.1 ( http://php.net/supported-versions.php )
 
-- `Fixes`  Cross-Origin Request Blocked: https://lycheeorg.github.io/update.json ( 3#121 )
+- `Fixes`  Cross-Origin Request Blocked: https://lycheeorg.dev/update.json ( 3#121 )
  The server is now doing the check for update (on `Session::init`) if this one fail, the user will do an ajax request to check if an update is available.
 - `Fixes` Syntax Error in Session.php ( 3#153 )
 - `Fixes` Small bugs ( 3#136 ,  3#157 , 3#159 ,  3#163 , 3#166 )
diff --git a/src/content/post/2024-06-29-Future-of-lychee.mdx b/src/content/post/2024-06-29-Future-of-lychee.mdx
@@ -49,7 +49,7 @@ It is very difficult to say, as I am not really able to estimate the amount of w
 
 At the moment, only [@d7415](https://github.com/d7415) and I ([@ildyria](https://github.com/ildyria)) are maintaining Lychee, [@d7415](https://github.com/d7415) doing most of the review work while I am working on fixing the bugs & trying to provide improvements. We aim to maintain this free open-source photography library with high quality of code.
 
-If you feel like helping us, don't hesitate to join us on [discord](https://discord.gg/dcEcQfYR) or [gitter](https://app.gitter.im/#/room/#LycheeOrg_Lobby:gitter.im).
+If you feel like helping us, don't hesitate to join us on [discord](https://discord.gg/dcEcQfYR).
 
 If you are using Lychee, a small token of gratitude will go a long way.
 You can support further development (and bug fixes!) of Lychee on [opencollective](https://opencollective.com/LycheeOrg) or on [GitHub](https://github.com/sponsors/LycheeOrg).
