Deploying to gh-pages from @ a210a02 🚀

en/docs/getting-started/index.html

@@ -9,4 +9,4 @@
         height: 100vh;
       }</style><aside id="content-toc" class="w-48 sticky docs-toc order-3 flex-shrink-0"><span class="block uppercase text-gray-600 font-bold text-xs tracking-wider pt-0">Contents</span><nav class="toc"><ol><li><a href="#setup-with-docker">Setup with Docker</a><ol><li><a href="#configure-compose-file">Configure compose file</a></li></ol></li><li><a href="#starting-the-server">Starting the server</a></li><li><a href="#setup-wizard">Setup Wizard</a></li></ol></nav></aside><main id="primary-content" class="mb-40 w-full px-14 py-14"><header class="flex justify-between items-center"><h1>Getting Started</h1><div class="flex items-center"><a title="Edit on GitHub" class="text-gray-500 hover:text-primaryDark no-underline" href="https://github.com/photoview/photoview.github.io/edit/master/./src/en/docs/getting-started/getting-started.md"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-3"><path d="M12 20h9"></path><path d="M16.5 3.5a2.121 2.121 0 0 1 3 3L7 19l-4 1 1-4L16.5 3.5z"></path></svg> </a><select class="ml-5" id="lg-switcher" onchange="changeLanguage()"><option class="lg-switcher-item" selected="selected" value="/en/docs/getting-started/">English</option><option class="lg-switcher-item" value="/fr/docs/getting-started/">Français</option></select><script>function changeLanguage() {
       document.location.href=document.getElementById("lg-switcher").value;
-    }</script></div></header><p><em>Get Photoview up and running as quickly as possible</em></p><h2 id="setup-with-docker" tabindex="-1"><a class="header-anchor" href="#setup-with-docker" aria-label="Anchor"></a> Setup with Docker</h2><p>The easiest way to setup Photoview is using Docker with docker-compose.</p><h3 id="configure-compose-file" tabindex="-1"><a class="header-anchor" href="#configure-compose-file" aria-label="Anchor"></a> Configure compose file</h3><p>Make a new <code>docker-compose.yml</code> file, and copy the content of <a href="https://github.com/photoview/photoview/blob/master/docker-compose.example.yml">docker-compose.example.yml</a> to it.</p><p>Edit <code>docker-compose.yml</code>, find the comments starting with <code>Change This:</code>, and change the values, to properly match your setup. If you are just testing locally, you don't have to change anything.</p><p>For more details see <a href="/en/docs/installation-docker/">Setup with Docker</a></p><h2 id="starting-the-server" tabindex="-1"><a class="header-anchor" href="#starting-the-server" aria-label="Anchor"></a> Starting the server</h2><p>Run the following command to start the server.</p><pre class="language-bash"><code class="language-bash"><span class="token function">docker-compose</span> up <span class="token parameter variable">-d</span></code></pre><p>If the endpoint or the port hasn't been changed in the <code>docker-compose.yml</code> file, Photoview can now be accessed at <a href="http://localhost:8000">http://localhost:8000</a></p><h2 id="setup-wizard" tabindex="-1"><a class="header-anchor" href="#setup-wizard" aria-label="Anchor"></a> Setup Wizard</h2><p>When you first visit the site, you should be presented with an initial setup wizard.</p><picture class="block w-100 my-8"><source type="image/webp" srcset="/images/ZsEb170UwY-512.webp 512w" sizes="100vw"><source type="image/jpeg" srcset="/images/ZsEb170UwY-512.jpeg 512w" sizes="100vw"><img src="/images/ZsEb170UwY-512.jpeg" alt="initial setup screen"></picture><p>Enter a new <strong>username</strong> and <strong>password</strong>.</p><p>For the <strong>photo path</strong>, enter the path in the docker container where your photos are located. This can be set from the <code>docker-compose.yml</code> file under <code>api</code> -&gt; <code>volumes</code>. The default location is <code>/photos</code></p><p>A new admin user will be created, with access to the photos located at the path provided under the initial setup.</p><p>The photos will have to be scanned before they show up, you can start a scan manually, by navigating to <code>Settings</code> and clicking on <code>Scan All</code></p></main></div></div><div id="search-overlay" class="hidden"><div id="search-dimmer" class="fixed top-0 left-0 w-full h-full bg-black opacity-10"></div><div class="fixed top-20 left-1/2 transform -translate-x-1/2 bg-white shadow-lg border border-gray-200 rounded-md p-4 w-40rem overflow-y-auto h-3/4" role="dialog"><input id="search-field" type="search" class="mb-4 w-full py-2 px-3 text-sm border border-gray-200 rounded-md" placeholder="Search" aria-autocomplete="list" autocomplete="off" autocorrect="off" autocapitalize="none" spellcheck="false" enterkeyhint="search" aria-controls="search-results-box"><div role="listbox" aria-label="Search" id="search-results-box" class="">Loading results...</div></div></div><script defer="defer" src="/docs/docs-scripts.js"></script></body></html>
+    }</script></div></header><p><em>Get Photoview up and running as quickly as possible</em></p><h2 id="setup-with-docker" tabindex="-1"><a class="header-anchor" href="#setup-with-docker" aria-label="Anchor"></a> Setup with Docker</h2><p>The easiest way to setup Photoview is using Docker with docker-compose.</p><h3 id="configure-compose-file" tabindex="-1"><a class="header-anchor" href="#configure-compose-file" aria-label="Anchor"></a> Configure compose file</h3><p>Make a new <code>docker-compose.yml</code> file, and copy the content of <a href="https://github.com/photoview/photoview/blob/master/docker-compose.example.yml">docker-compose.example.yml</a> to it.</p><p>Edit <code>docker-compose.yml</code>, find the comments starting with <code>Change This:</code>, and change the values, to properly match your setup. If you are just testing locally, you don't have to change anything.</p><p>For more details see <a href="/en/docs/installation-docker/">Setup with Docker</a></p><h2 id="starting-the-server" tabindex="-1"><a class="header-anchor" href="#starting-the-server" aria-label="Anchor"></a> Starting the server</h2><p>Run the following command to start the server.</p><pre class="language-bash"><code class="language-bash">docker-compose up -d</code></pre><p>If the endpoint or the port hasn't been changed in the <code>docker-compose.yml</code> file, Photoview can now be accessed at <a href="http://localhost:8000">http://localhost:8000</a></p><h2 id="setup-wizard" tabindex="-1"><a class="header-anchor" href="#setup-wizard" aria-label="Anchor"></a> Setup Wizard</h2><p>When you first visit the site, you should be presented with an initial setup wizard.</p><picture class="block w-100 my-8"><source type="image/webp" srcset="/images/ZsEb170UwY-512.webp 512w" sizes="100vw"><source type="image/jpeg" srcset="/images/ZsEb170UwY-512.jpeg 512w" sizes="100vw"><img src="/images/ZsEb170UwY-512.jpeg" alt="initial setup screen"></picture><p>Enter a new <strong>username</strong> and <strong>password</strong>.</p><p>For the <strong>photo path</strong>, enter the path in the docker container where your photos are located. This can be set from the <code>docker-compose.yml</code> file under <code>api</code> -&gt; <code>volumes</code>. The default location is <code>/photos</code></p><p>A new admin user will be created, with access to the photos located at the path provided under the initial setup.</p><p>The photos will have to be scanned before they show up, you can start a scan manually, by navigating to <code>Settings</code> and clicking on <code>Scan All</code></p></main></div></div><div id="search-overlay" class="hidden"><div id="search-dimmer" class="fixed top-0 left-0 w-full h-full bg-black opacity-10"></div><div class="fixed top-20 left-1/2 transform -translate-x-1/2 bg-white shadow-lg border border-gray-200 rounded-md p-4 w-40rem overflow-y-auto h-3/4" role="dialog"><input id="search-field" type="search" class="mb-4 w-full py-2 px-3 text-sm border border-gray-200 rounded-md" placeholder="Search" aria-autocomplete="list" autocomplete="off" autocorrect="off" autocapitalize="none" spellcheck="false" enterkeyhint="search" aria-controls="search-results-box"><div role="listbox" aria-label="Search" id="search-results-box" class="">Loading results...</div></div></div><script defer="defer" src="/docs/docs-scripts.js"></script></body></html>

en/docs/usage-nextcloud/index.html

@@ -9,4 +9,6 @@
         height: 100vh;
       }</style><aside id="content-toc" class="w-48 sticky docs-toc order-3 flex-shrink-0"><span class="block uppercase text-gray-600 font-bold text-xs tracking-wider pt-0">Contents</span><nav class="toc"><ol><li><a href="#locating-nextcloud-files-on-the-filesystem">Locating Nextcloud files on the filesystem</a></li><li><a href="#configure-photoview">Configure Photoview</a><ol><li><a href="#adding-path-as-a-docker-volume">Adding path as a Docker volume</a></li></ol></li><li><a href="#add-path-to-photoview-user">Add path to Photoview user</a></li><li><a href="#keep-photoview-updated-automatically">Keep Photoview updated automatically</a></li></ol></nav></aside><main id="primary-content" class="mb-40 w-full px-14 py-14"><header class="flex justify-between items-center"><h1>Using with Nextcloud</h1><div class="flex items-center"><a title="Edit on GitHub" class="text-gray-500 hover:text-primaryDark no-underline" href="https://github.com/photoview/photoview.github.io/edit/master/./src/en/docs/usage-nextcloud.md"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-3"><path d="M12 20h9"></path><path d="M16.5 3.5a2.121 2.121 0 0 1 3 3L7 19l-4 1 1-4L16.5 3.5z"></path></svg> </a><select class="ml-5" id="lg-switcher" onchange="changeLanguage()"><option class="lg-switcher-item" selected="selected" value="/en/docs/usage-nextcloud/">English</option><option class="lg-switcher-item" value="/fr/docs/usage-nextcloud/">Français</option></select><script>function changeLanguage() {
       document.location.href=document.getElementById("lg-switcher").value;
-    }</script></div></header><p>Photoview can be configured to grab media from <a href="https://nextcloud.com/">Nextcloud</a>.</p><h2 id="locating-nextcloud-files-on-the-filesystem" tabindex="-1"><a class="header-anchor" href="#locating-nextcloud-files-on-the-filesystem" aria-label="Anchor"></a> Locating Nextcloud files on the filesystem</h2><p>All files uploaded to Nextcloud are located in the folder called <code>data/</code> at the location where Nextcloud is installed. Inside that folder you will find another folder for each Nextcloud user. All files uploaded by a user is located inside their respective folders.</p><p>Now find the path to where your Nextcloud media is located, and copy it as we will need it later. The path could look somthing like this:</p><p>~/nextcloud/data/example_user/files/Photos</p><h2 id="configure-photoview" tabindex="-1"><a class="header-anchor" href="#configure-photoview" aria-label="Anchor"></a> Configure Photoview</h2><p>The next step will be to add this path to the desired Photoview user.</p><h3 id="adding-path-as-a-docker-volume" tabindex="-1"><a class="header-anchor" href="#adding-path-as-a-docker-volume" aria-label="Anchor"></a> Adding path as a Docker volume</h3><blockquote><p>If you are not running Photoview in Docker you can skip this step.</p></blockquote><p>Before the Nextcloud files can be accessed by the Photoview container, they must first be mounted as a <a href="https://docs.docker.com/storage/volumes/">volume</a>.</p><p>For docker-compose this can be done by adding the volume to the <code>docker-compose.yml</code> configuration file for Photoview. Open it up and under <code>volumes:</code> add a new volume like so:</p><p>- NEXTCLOUD_PATH:/nextcloud:ro</p><p>Replace <code>NEXTCLOUD_PATH</code> with the path you copied in step 1. The <code>/nextcloud</code> path dictates where this mount can be accessed from within the container, this will be important for the next step. The <code>:ro</code> in the end, instructs Docker to mount the folder in read-only mode.</p><p>Now restart the docker container.</p><h2 id="add-path-to-photoview-user" tabindex="-1"><a class="header-anchor" href="#add-path-to-photoview-user" aria-label="Anchor"></a> Add path to Photoview user</h2><p>You can now add the new path the desired user from the Settings page, by clicking on the <code>Edit</code> button next to the user. From there you can add the new path.</p><p>If you mounted the volume like in the previous step, the path will be <code>/nextcloud</code>. When the path has been added, you can click <code>Save</code>. You can now scan the user and the pictures and videos from nextcloud will appear in Photoview.</p><h2 id="keep-photoview-updated-automatically" tabindex="-1"><a class="header-anchor" href="#keep-photoview-updated-automatically" aria-label="Anchor"></a> Keep Photoview updated automatically</h2><p>If you don't want to press the <code>Scan</code> button manually each time you've added new files to Nextcloud, you can <a href="/en/docs/usage-settings/#periodic-scanner">configure a periodic scanner</a> to automatically scan for changes.</p></main></div></div><div id="search-overlay" class="hidden"><div id="search-dimmer" class="fixed top-0 left-0 w-full h-full bg-black opacity-10"></div><div class="fixed top-20 left-1/2 transform -translate-x-1/2 bg-white shadow-lg border border-gray-200 rounded-md p-4 w-40rem overflow-y-auto h-3/4" role="dialog"><input id="search-field" type="search" class="mb-4 w-full py-2 px-3 text-sm border border-gray-200 rounded-md" placeholder="Search" aria-autocomplete="list" autocomplete="off" autocorrect="off" autocapitalize="none" spellcheck="false" enterkeyhint="search" aria-controls="search-results-box"><div role="listbox" aria-label="Search" id="search-results-box" class="">Loading results...</div></div></div><script defer="defer" src="/docs/docs-scripts.js"></script></body></html>
+    }</script></div></header><p>Photoview can be configured to grab media from <a href="https://nextcloud.com/">Nextcloud</a>.</p><h2 id="locating-nextcloud-files-on-the-filesystem" tabindex="-1"><a class="header-anchor" href="#locating-nextcloud-files-on-the-filesystem" aria-label="Anchor"></a> Locating Nextcloud files on the filesystem</h2><p>All files uploaded to Nextcloud are located in the folder called <code>data/</code> at the location where Nextcloud is installed. Inside that folder you will find another folder for each Nextcloud user. All files uploaded by a user is located inside their respective folders.</p><p>Now find the path to where your Nextcloud media is located, and copy it as we will need it later. The path could look somthing like this:</p><pre><code>~/nextcloud/data/example_user/files/Photos
+</code></pre><h2 id="configure-photoview" tabindex="-1"><a class="header-anchor" href="#configure-photoview" aria-label="Anchor"></a> Configure Photoview</h2><p>The next step will be to add this path to the desired Photoview user.</p><h3 id="adding-path-as-a-docker-volume" tabindex="-1"><a class="header-anchor" href="#adding-path-as-a-docker-volume" aria-label="Anchor"></a> Adding path as a Docker volume</h3><blockquote><p>If you are not running Photoview in Docker you can skip this step.</p></blockquote><p>Before the Nextcloud files can be accessed by the Photoview container, they must first be mounted as a <a href="https://docs.docker.com/storage/volumes/">volume</a>.</p><p>For docker-compose this can be done by adding the volume to the <code>docker-compose.yml</code> configuration file for Photoview. Open it up and under <code>volumes:</code> add a new volume like so:</p><pre><code>- NEXTCLOUD_PATH:/nextcloud:ro
+</code></pre><p>Replace <code>NEXTCLOUD_PATH</code> with the path you copied in step 1. The <code>/nextcloud</code> path dictates where this mount can be accessed from within the container, this will be important for the next step. The <code>:ro</code> in the end, instructs Docker to mount the folder in read-only mode.</p><p>Now restart the docker container.</p><h2 id="add-path-to-photoview-user" tabindex="-1"><a class="header-anchor" href="#add-path-to-photoview-user" aria-label="Anchor"></a> Add path to Photoview user</h2><p>You can now add the new path the desired user from the Settings page, by clicking on the <code>Edit</code> button next to the user. From there you can add the new path.</p><p>If you mounted the volume like in the previous step, the path will be <code>/nextcloud</code>. When the path has been added, you can click <code>Save</code>. You can now scan the user and the pictures and videos from nextcloud will appear in Photoview.</p><h2 id="keep-photoview-updated-automatically" tabindex="-1"><a class="header-anchor" href="#keep-photoview-updated-automatically" aria-label="Anchor"></a> Keep Photoview updated automatically</h2><p>If you don't want to press the <code>Scan</code> button manually each time you've added new files to Nextcloud, you can <a href="/en/docs/usage-settings/#periodic-scanner">configure a periodic scanner</a> to automatically scan for changes.</p></main></div></div><div id="search-overlay" class="hidden"><div id="search-dimmer" class="fixed top-0 left-0 w-full h-full bg-black opacity-10"></div><div class="fixed top-20 left-1/2 transform -translate-x-1/2 bg-white shadow-lg border border-gray-200 rounded-md p-4 w-40rem overflow-y-auto h-3/4" role="dialog"><input id="search-field" type="search" class="mb-4 w-full py-2 px-3 text-sm border border-gray-200 rounded-md" placeholder="Search" aria-autocomplete="list" autocomplete="off" autocorrect="off" autocapitalize="none" spellcheck="false" enterkeyhint="search" aria-controls="search-results-box"><div role="listbox" aria-label="Search" id="search-results-box" class="">Loading results...</div></div></div><script defer="defer" src="/docs/docs-scripts.js"></script></body></html>