Skip to content

Commit

Permalink
Deploying to gh-pages from @ da918c9 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ildyria committed Sep 25, 2023
1 parent 2581fe9 commit e2d02f9
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 12 deletions.
53 changes: 48 additions & 5 deletions docs/advanced-setups.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ <h1>Advanced Setups</h1>
<li><a href="#s3-object-storage-setup">S3 Object Storage Setup</a></li>
<li><a href="#create-and-run-lychee-container">Create and run Lychee container</a></li>
<li><a href="#configure-env">Configure .ENV</a></li>
<li><a href="#limitations-to-be-considered">Limitations to be considered</a></li>
<li><a href="#setup-apache">Setup Apache</a></li>
<li><a href="#configure-lychee">Configure Lychee</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -331,10 +332,52 @@ <h3 id="create-and-run-lychee-container"><a class="toclink" href="#create-and-ru
</code></pre>
<h3 id="configure-env"><a class="toclink" href="#configure-env">Configure .ENV</a></h3>
<p>To avoid latency when clicking Diagnostics, my suggestion is to disable BasicPermissionCheck. Otherwise, depending on the number of photos in your gallery, this task can take hours.</p>
<p><code>/var/lib/containers/storage/volumes/lychee-conf/_data/.env
SKIP_DIAGNOSTICS_CHECKS=BasicPermissionCheck</code></p>
<h3 id="limitations-to-be-considered"><a class="toclink" href="#limitations-to-be-considered">Limitations to be considered</a></h3>
<p>As explained before, recursive tasks are penalised in Object Storage, so if you have an existing bucket and the container runs for the first time, it will take long time to review and set the permissions in your mount. Depending on the number of photos, it can take several hours.</p>
<p>```/var/lib/containers/storage/volumes/lychee-conf/_data/.env
SKIP_DIAGNOSTICS_CHECKS=BasicPermissionCheck</p>
<pre><code>
### Limitations to be considered
As explained before, recursive tasks are penalised in Object Storage, so if you have an existing bucket and the container runs for the first time, it will take long time to review and set the permissions in your mount. Depending on the number of photos, it can take several hours.

## Hosting Lychee in a subpath with Apache

To serve Lychee in a subpath, e.g. `https://my.url/photos/`, we can use Apaches's [Alias](https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias)-directive.

In this example we assume the web root to be located at `/var/www/html`, the web user and group to be `www-data`, and install [from the master branch](installation.html#from-the-master-branch).

Before getting started, make sure your system qualifies the [Server Requirements](installation.html#server-requirements).

### Setup Lychee

Clone the repository to outside the web root, e.g. `/var/www/`:

```bash
sudo git clone https://www.github.com/LycheeOrg/Lychee /var/www/
</code></pre>
<p>Set the file ownership and permissions:</p>
<pre><code class="language-bash">sudo chown -R www-data:www-data /var/www/Lychee
sudo chmod -R 2775 /var/www/Lychee
</code></pre>
<p>Install composer in <code>/var/www/Lychee</code> as instructed in <a href="https://getcomposer.org/download/">here</a>. Then, from <code>/var/www/Lychee</code>, install the project dependencies:</p>
<pre><code class="language-bash">sudo -u www-data php composer.phar install --no-dev
</code></pre>
<h3 id="setup-apache"><a class="toclink" href="#setup-apache">Setup Apache</a></h3>
<p>Link <code>https://my.url/photos/</code> to <code>/var/www/Lychee/public</code> by adding the following to your Apache configuration for Aliases. In Apache 2.4 running on Debian, the correct configuration file is <code>/etc/apache2/mods-available/alias.conf</code>.</p>
<pre><code class="language-apacheconf">Alias /photos /var/www/Lychee/public

&lt;Directory /var/www/Lychee/public&gt;
Options FollowSymLinks
AllowOverride All
Require all granted
&lt;/Directory&gt;
</code></pre>
<p>Finally, restart Apache:</p>
<pre><code class="language-bash">sudo service apache2 restart
</code></pre>
<h3 id="configure-lychee"><a class="toclink" href="#configure-lychee">Configure Lychee</a></h3>
<p>At this point, you should be able to go to <code>https://my.url/photos/</code> and run the web installer. During the installation procedure, on top of adding the database credentials to match your setup, set your <code>APP_URL</code> to the served subdirectory:</p>
<pre><code class="language-bash">APP_URL=https://my.url/photos/
</code></pre>
<p>Done!</p>
</div><blockquote><p>{tip} Caught a mistake or want to contribute to the documentation?&nbsp;<a href="https://github.com/LycheeOrg/LycheeOrg.github.io/tree/master/docs/advanced-setups.md">Edit this page on Github!</a></p></blockquote>
</section>
</section>
Expand Down
3 changes: 1 addition & 2 deletions docs/faq_installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,7 @@ <h3 id="can-i-host-lychee-with-a-subpath-with-nginx-like-httpsexampledevlychee">
}
</code></pre>
<h3 id="can-i-host-lychee-with-a-subpath-with-apache-like-httpsexampledevlychee"><a class="toclink" href="#can-i-host-lychee-with-a-subpath-with-apache-like-httpsexampledevlychee">Can I host Lychee with a subpath with Apache? Like <code>https://example.dev/lychee/</code></a></h3>
<p>Yes, just create a Symbolic Link and allow your apache configuration to follow them.
At website.com root <code>ln -s Lychee/public pics</code> and you will get exactly what you want: <code>website.com/pics</code></p>
<p>Yes, the process is described <a href="advanced-setups.html#hosting-lychee-in-a-subpath-with-apache">here</a>.</p>
<h3 id="do-we-really-need-writable-app"><a class="toclink" href="#do-we-really-need-writable-app">Do we really need writable <code>app/</code>?</a></h3>
<p>From <a href="https://github.com/LycheeOrg/Lychee/issues/311">#311</a></p>
<p>Short answer: Lychee will work without a writable <code>app/</code> folder.</p>
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"url": "https://LycheeOrg.github.io/",
"image": "https://LycheeOrg.github.io/assets/images/og.jpg",
"description": "Lychee is a free photo-management tool, which runs on your server or web-space. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely.",
"softwareVersion": "4.12.0",
"softwareVersion": "4.13.0",
"applicationCategory": "Photo Management",
"sameAs": [
"https://twitter.com/getlychee"
Expand All @@ -61,7 +61,7 @@
<div class="header__column">
<div class="align align--left">
<p class="header__headline">
<a href=".">Lychee <span>4.12.0</span></a>
<a href=".">Lychee <span>4.13.0</span></a>
</p>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions support.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"url": "https://LycheeOrg.github.io/",
"image": "https://LycheeOrg.github.io/assets/images/og.jpg",
"description": "Lychee is a free photo-management tool, which runs on your server or web-space. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely.",
"softwareVersion": "4.12.0",
"softwareVersion": "4.13.0",
"applicationCategory": "Photo Management",
"sameAs": [
"https://twitter.com/getlychee"
Expand All @@ -61,7 +61,7 @@
<div class="header__column">
<div class="align align--left">
<p class="header__headline">
<a href=".">Lychee <span>4.12.0</span></a>
<a href=".">Lychee <span>4.13.0</span></a>
</p>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion update.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"lychee": {
"version": 41200
"version": 41300
}
}

0 comments on commit e2d02f9

Please sign in to comment.