Skip to content

Commit

Permalink
Deploying to gh-pages from @ 5251e30 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ildyria committed Jan 30, 2024
1 parent 80736b2 commit bdca22f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 25 deletions.
26 changes: 2 additions & 24 deletions docs/faq_general.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ <h1>General</h1>
<li><a href="#how-to-add-custom-scripts">How to add custom scripts?</a></li>
<li><a href="#how-is-the-upload-folder-protected">How is the upload folder protected?</a></li>
<li><a href="#my-login-is-timing-out-after-two-hours-how-can-this-be-changed">My login is timing out after two hours, how can this be changed?</a></li>
<li><a href="#how-can-i-clear-the-logs">How can I clear the Logs?</a></li>
<li><a href="#how-can-i-see-the-correct-client-ip-address-when-running-lychee-behind-cloudflare">How can I see the correct client IP address when running Lychee behind Cloudflare?</a></li>
<li><a href="#can-i-set-up-lychee-to-watch-a-folder-for-new-images-and-automatically-add-them-to-albums">Can I set up Lychee to watch a folder for new images and automatically add them to albums?</a></li>
<li><a href="#special-right-click-menu-doesnt-appear-for-new-users">Special right-click menu doesn't appear for new users?</a></li>
Expand Down Expand Up @@ -168,18 +167,7 @@ <h3 id="how-to-change-the-title-of-the-site"><a class="toclink" href="#how-to-ch
<h3 id="how-to-reset-username-and-password"><a class="toclink" href="#how-to-reset-username-and-password">How to reset username and password?</a></h3>
<p>Via SSH, use the command <code>php artisan lychee:reset_admin</code>.</p>
<h3 id="how-to-hide-smart-albums"><a class="toclink" href="#how-to-hide-smart-albums">How to hide smart albums?</a></h3>
<p>Add the following custom CSS to your <code>user.css</code> or via the settings menu:</p>
<pre><code class="language-css">[data-id=&quot;unsorted&quot;] { display:none; }
[data-id=&quot;public&quot;] { display:none; }
[data-id=&quot;starred&quot;] { display:none; }
[data-id=&quot;recent&quot;] { display:none; }
div#lychee_view_content &gt; div.divider:first-child { display:none; }
div#lychee_view_content &gt; div.divider:nth-child(6) {
margin-top: 10px;
border-top: 0;
box-shadow: none;
}
</code></pre>
<p>Go into your <em>Settings</em> then <em>More</em>, find <code>SA_enabled</code> in the <em>"Smart Albums"</em> section and set it to <code>0</code>.</p>
<h3 id="how-to-disable-the-zoom-animation-while-browsing-pictures"><a class="toclink" href="#how-to-disable-the-zoom-animation-while-browsing-pictures">How to disable the 'zoom' animation while browsing pictures?</a></h3>
<p>Add the following custom CSS to your <code>user.css</code> or via the settings menu:</p>
<pre><code class="language-css">#imageview #image {
Expand Down Expand Up @@ -267,7 +255,7 @@ <h4 id="option-2-using-an-external-font-hosting-service"><a class="toclink" href
</code></pre>
<p>Change the URLs <code>https://fonts.googleapis.com</code> and <code>https://fonts.gstatic.com</code> to match your provider's URLs.</p>
<h3 id="how-to-add-custom-scripts"><a class="toclink" href="#how-to-add-custom-scripts">How to add custom scripts?</a></h3>
<p>If you want to add custom scripts, for example to add an analytics service, you can add the script code to the <code>additional_footer_text</code> setting. For example, adding <code>&lt;script&gt;alert('Hello World!');&lt;/script&gt;</code> to it will display an alert dialog with <code>Hello World!</code> in it every time you load the page.</p>
<p>Edit the <code>custom.js</code> file in <code>/path/to/lychee/public/dist/</code> or use the <em>"Personalize JS"</em> area in <em>Settings</em>.</p>
<h3 id="how-is-the-upload-folder-protected"><a class="toclink" href="#how-is-the-upload-folder-protected">How is the upload folder protected?</a></h3>
<p>From <a href="https://github.com/LycheeOrg/Lychee/issues/304">#304</a></p>
<p>Short version: It's not protected</p>
Expand All @@ -276,12 +264,6 @@ <h3 id="how-is-the-upload-folder-protected"><a class="toclink" href="#how-is-the
<p><a href="https://github.com/ildyria">@ildyria</a> recently posted the following link on how a more effective protection could be implemented: https://bedigit.com/blog/laravel-5-how-to-access-image-uploaded-in-storage-within-view/. He didn't go down that route himself due to performance concerns but we agree that if somebody contributed a clean implementation as an option, we'd probably accept it.</p>
<h3 id="my-login-is-timing-out-after-two-hours-how-can-this-be-changed"><a class="toclink" href="#my-login-is-timing-out-after-two-hours-how-can-this-be-changed">My login is timing out after two hours, how can this be changed?</a></h3>
<p>You can edit your <code>.env</code> and modify the <code>SESSION_LIFETIME=120</code> part (in minutes).</p>
<h3 id="how-can-i-clear-the-logs"><a class="toclink" href="#how-can-i-clear-the-logs">How can I clear the Logs?</a></h3>
<p>To remove the <code>Notice</code> and <code>Warnings</code>, simply click on the button at the top of the Log page.
However if the page is too heavy to load, you can either manually empty the <code>Logs</code> table or use artisan:</p>
<pre><code class="language-bash">cd Lychee
php artisan lychee:logs clean
</code></pre>
<h3 id="how-can-i-see-the-correct-client-ip-address-when-running-lychee-behind-cloudflare"><a class="toclink" href="#how-can-i-see-the-correct-client-ip-address-when-running-lychee-behind-cloudflare">How can I see the correct client IP address when running Lychee behind Cloudflare?</a></h3>
<p>Please see <a href="https://github.com/monicahq/laravel-cloudflare">https://github.com/monicahq/laravel-cloudflare</a>. The Lychee file that needs changing can be found <a href="https://github.com/LycheeOrg/Lychee/blob/master/app/Http/Middleware/TrustProxies.php">here</a>.</p>
<h3 id="can-i-set-up-lychee-to-watch-a-folder-for-new-images-and-automatically-add-them-to-albums"><a class="toclink" href="#can-i-set-up-lychee-to-watch-a-folder-for-new-images-and-automatically-add-them-to-albums">Can I set up Lychee to watch a folder for new images and automatically add them to albums?</a></h3>
Expand All @@ -295,10 +277,6 @@ <h3 id="special-right-click-menu-doesnt-appear-for-new-users"><a class="toclink"
<img alt="" src="img/special-right-click-missing.png" /></p>
<p>No this is normal. This user does not have the ownership of that Album, so the right click is not available. You can see <em>sharing</em> as a <em>read</em> permission.</p>
<h3 id="the-divider-h1-shows-the-text-admin-when-logged-in-with-an-ordinary-user-shoulnt-this-be-albums"><a class="toclink" href="#the-divider-h1-shows-the-text-admin-when-logged-in-with-an-ordinary-user-shoulnt-this-be-albums">The divider h1 shows the text "Admin" when logged in with an ordinary user. Shouln't this be "Albums"?</a></h3>
<!-- TODO add deprecation notice once https://github.com/LycheeOrg/Lychee/pull/1539 is merged
> {note} This is a behavior of Lychee that only occurs if the admin user did not log in after the update. Please contact the admin to log in once. After this, the admin's username is shown instead of `Admin`.
-->

<p>Actually no, this is because the user does not have any albums (yet). The <code>h1</code> divider is to show who is the owner of those albums. See below.
<img alt="2020-02-19_3840x1080_12:29:19" src="https://user-images.githubusercontent.com/627094/74830496-92c3a200-5313-11ea-9065-60cb8090c7ac.png" />
And yes the right-click menu is available on the <em>PhD Defenses</em> part but not in the <em>Admin</em> parts.
Expand Down
8 changes: 7 additions & 1 deletion docs/faq_troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ <h1>Troubleshooting</h1>
<li><a href="#i-know-my-sql-database-is-setup-correctly-but-lychee-is-showing-sqlstatehy000-2002-no-such-file-or-directory-and-is-not-able-to-make-changes-to-the-database">I know my SQL database is setup correctly, but Lychee is showing SQLSTATE[HY000] [2002] No such file or directory and is not able to make changes to the database.</a></li>
<li><a href="#why-are-there-messages-about-git-files-in-my-logs-eg-githead-failed-to-open-stream-no-such-file-or-directory">Why are there messages about git files in my logs? (e.g. .git/HEAD: failed to open stream: No such file or directory)</a></li>
<li><a href="#import-from-server-via-symlink-is-failing">Import from server via symlink is failing.</a></li>
<li><a href="#uploads-are-not-working-with-cloudfare-behind-a-reverse-proxy">Uploads are not working with Cloudfare / behind a reverse proxy.</a></li>
<li><a href="#i-get-an-error-sqlstate-numeric-value-out-of-range-1264-out-of-range-value-for-column-legacy_id-what-should-i-do">I get an error SQLSTATE: Numeric value out of range: 1264 Out of range value for column 'legacy_id', what should I do?</a></li>
</ul>

<hr> <h3 id="lychee-is-not-working"><a class="toclink" href="#lychee-is-not-working">Lychee is not working</a></h3>
Expand Down Expand Up @@ -272,7 +274,11 @@ <h3 id="import-from-server-via-symlink-is-failing"><a class="toclink" href="#imp
<p>As a result, in order to use this function the file system on which <code>/uploads</code> resides must support symbolic links (e.g. ext3, ext4, btrfs, zfs, etc.).
<em>"Windows"</em> file systems (e.g. NTFS, FAT, CIFS) won't work.
The directory with the original media files may still be a Windows file system.
This is, because symbolic links (as opposed to hard links) may cross file system boundaries.</p><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/faq_troubleshooting.md">Edit this page on Github!</a></p></blockquote>
This is, because symbolic links (as opposed to hard links) may cross file system boundaries.</p>
<h3 id="uploads-are-not-working-with-cloudfare-behind-a-reverse-proxy"><a class="toclink" href="#uploads-are-not-working-with-cloudfare-behind-a-reverse-proxy">Uploads are not working with Cloudfare / behind a reverse proxy.</a></h3>
<p>Check that the value of <code>TRUSTED_PROXIES</code> is correctly set in your <code>.env</code> file.</p>
<h3 id="i-get-an-error-sqlstate-numeric-value-out-of-range-1264-out-of-range-value-for-column-legacy_id-what-should-i-do"><a class="toclink" href="#i-get-an-error-sqlstate-numeric-value-out-of-range-1264-out-of-range-value-for-column-legacy_id-what-should-i-do">I get an error SQLSTATE: Numeric value out of range: 1264 Out of range value for column 'legacy_id', what should I do?</a></h3>
<p>Go into your <em>Settings</em> then <em>More</em>, find <code>force_32bit_ids</code> in the <em>"config"</em> section and set it to <code>1</code>.</p><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/faq_troubleshooting.md">Edit this page on Github!</a></p></blockquote>
</section>
</section>
</section>
Expand Down

0 comments on commit bdca22f

Please sign in to comment.