Deploying to gh-pages from @ c77454a 🚀

docs/usage-scanner/index.html

@@ -7,4 +7,4 @@
         right: 0;
         width: 100vw;
         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></aside><main id="primary-content" class="mb-40 w-full px-14 py-14"><header class="flex justify-between items-center"><h1>File scanner</h1><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/docs/usage-scanner.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></header><blockquote><p>TODO: Explain how the scanner works:</p><ul><li>Overview / Introduction</li><li>Thumbnail generation and cache</li><li>What file types can be scanned: images, videos, RAW</li><li>Having multiple file paths per user and overlapping file paths, and when are cached thumbnails deleted</li></ul></blockquote></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>
+      }</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="#supported-file-types">Supported file types</a></li><li><a href="#thumbnail-generation">Thumbnail generation</a></li><li><a href="#ignorefiles">Ignorefiles</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>File scanner</h1><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/docs/usage-scanner.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></header><p>Each user in Photoview is assigned a set of <em>file paths</em>, when the scanner runs it will search for media within each path.</p><p>A user can have multiple file paths but one cannot be contained within another one.</p><p>Two users can have overlapping file paths. When this is done, each shared media will only be processed once by the scanner, such that the cache doesn't contain duplicates, but public shares will be individual to each user, and so will media favorites.</p><h2 id="supported-file-types" tabindex="-1"><a class="header-anchor" href="#supported-file-types" aria-label="Anchor"></a> Supported file types</h2><p>Photoview supports the browser native image formats out of the box (JPEG, PNG, GIF etc.). But for files not understood by the browser, Photoview can use tools to convert these files into browser supported types. It can use <a href="https://www.darktable.org/">Darktable</a> to process RAW image files and <a href="https://www.ffmpeg.org/">Ffmpeg</a> to process video formats.</p><p>A complete list of supported file formats can be found in the <a href="https://github.com/photoview/photoview/blob/master/api/scanner/media_type/media_type.go">media_type.go</a> source file.</p><h2 id="thumbnail-generation" tabindex="-1"><a class="header-anchor" href="#thumbnail-generation" aria-label="Anchor"></a> Thumbnail generation</h2><p>When the scanner finds a new image it generates a small sized thumbnail to be used when many images are shown at once. It saves this thumbnail to the media cache directory, as specified by the <code>PHOTOVIEW_MEDIA_CACHE</code> <a href="http://localhost:8080/docs/installation-environment-variables/#general">environment variable</a>.</p><p>In addition to the thumbnail, Photoview will also generate a high resolution version JPEG version of the image, if the file format of the original image cannot be displayed in the browser, for example a RAW image.</p><h2 id="ignorefiles" tabindex="-1"><a class="header-anchor" href="#ignorefiles" aria-label="Anchor"></a> Ignorefiles</h2><p>Inside any media directory a <code>.photoviewignore</code> file can be added with rules for files and directories to ignore. The rules will be applied from the directory it is placed in and all its subdirectories. If another ignore file is present in one of the subdirectories the rules will be merged.</p><p>Ignore rules follow the <a href="https://git-scm.com/docs/gitignore#_pattern_format">format of <code>.gitignore</code> files</a>.</p><pre class="language-gitignore"><code class="language-gitignore"><span class="token comment"># ignores all directories with the name `directory_name`</span><br><span class="token entry string">directory_name<span class="token punctuation">/</span></span><br><br><span class="token comment"># ignore all files with the .jpg extension</span><br><span class="token entry string"><span class="token operator">*</span>.jpg</span><br><br><span class="token comment"># make an exception to the previous rule for files named `image.jpg`</span><br><span class="token entry string"><span class="token operator">!</span>image.jpg</span></code></pre></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>

docs/usage-settings/index.html

@@ -7,4 +7,4 @@
         right: 0;
         width: 100vw;
         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="#manage-users">Manage users</a><ol><li><a href="#add-and-remove-users">Add and remove users</a></li><li><a href="#editing-users">Editing users</a></li></ol></li><li><a href="#scanner">Scanner</a><ol><li><a href="#periodic-scanner">Periodic Scanner</a></li><li><a href="#concurrent-workers">Concurrent Workers</a></li></ol></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>Settings Page</h1><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/docs/usage-settings/usage-settings.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></header><h2 id="manage-users" tabindex="-1"><a class="header-anchor" href="#manage-users" aria-label="Anchor"></a> Manage users</h2><h3 id="add-and-remove-users" tabindex="-1"><a class="header-anchor" href="#add-and-remove-users" aria-label="Anchor"></a> Add and remove users</h3><blockquote><p>TODO: Write this section explaining how users are added and deleted and what the consequences are.<br>Maybe also how to set a password for new users.</p></blockquote><h3 id="editing-users" tabindex="-1"><a class="header-anchor" href="#editing-users" aria-label="Anchor"></a> Editing users</h3><p>A user can be edited by clicking on the <code>Edit</code> button for the user.</p><blockquote><p>TODO: Update <strong>Photo path</strong> to explain how this is done in version 2. Also explain how paths can be shared across users.</p></blockquote><p><strong>Photo path:</strong> is the path on the file system of the server from where the media of the user is located. Note if running Docker, that this refers to the file system of the container and not the host.</p><p><strong>Admin:</strong> if the user is marked as admin, they will have access to the settings page.</p><blockquote><p>TODO: Update screen shot to reflect the settings in version 2.</p></blockquote><picture class="block w-full my-8"><source type="image/webp" srcset="/images/bu05vI5oEm-640.webp 640w, /images/bu05vI5oEm-1332.webp 1332w" sizes="100vw"><source type="image/jpeg" srcset="/images/bu05vI5oEm-640.jpeg 640w, /images/bu05vI5oEm-1332.jpeg 1332w" sizes="100vw"><img src="/images/bu05vI5oEm-640.jpeg" alt="screenshot of editing a user"></picture><h2 id="scanner" tabindex="-1"><a class="header-anchor" href="#scanner" aria-label="Anchor"></a> Scanner</h2><h3 id="periodic-scanner" tabindex="-1"><a class="header-anchor" href="#periodic-scanner" aria-label="Anchor"></a> Periodic Scanner</h3><p>When the periodic scanner is enabled, Photoview will automatically scan all users for new media at a fixed time interval.</p><picture class="block w-96 my-8"><source type="image/webp" srcset="/images/VrqTliQxpb-640.webp 640w" sizes="100vw"><source type="image/jpeg" srcset="/images/VrqTliQxpb-640.jpeg 640w" sizes="100vw"><img src="/images/VrqTliQxpb-640.jpeg" alt="screenshot of periodic scanner"></picture><h3 id="concurrent-workers" tabindex="-1"><a class="header-anchor" href="#concurrent-workers" aria-label="Anchor"></a> Concurrent Workers</h3><blockquote><p>TODO: Explain what the concurrent workers setting does</p></blockquote></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>
+      }</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="#manage-users">Manage users</a><ol><li><a href="#add-and-remove-users">Add and remove users</a></li><li><a href="#editing-users">Editing users</a></li></ol></li><li><a href="#scanner">Scanner</a><ol><li><a href="#periodic-scanner">Periodic Scanner</a></li><li><a href="#concurrent-workers">Concurrent Workers</a></li></ol></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>Settings Page</h1><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/docs/usage-settings/usage-settings.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></header><h2 id="manage-users" tabindex="-1"><a class="header-anchor" href="#manage-users" aria-label="Anchor"></a> Manage users</h2><h3 id="add-and-remove-users" tabindex="-1"><a class="header-anchor" href="#add-and-remove-users" aria-label="Anchor"></a> Add and remove users</h3><p>To add a new user, click the <code>New user</code> button and fill in the username and a media path for the new user. After creating a new user, make sure to add a password to the account as well, by clicking on the <code>Change password</code> button, next to the user.</p><picture class="block w-full my-8"><source type="image/webp" srcset="/images/ROapVmMCZu-640.webp 640w, /images/ROapVmMCZu-2244.webp 2244w" sizes="100vw"><source type="image/jpeg" srcset="/images/ROapVmMCZu-640.jpeg 640w, /images/ROapVmMCZu-2244.jpeg 2244w" sizes="100vw"><img src="/images/ROapVmMCZu-640.jpeg" alt="screenshot of adding a new user"></picture><h3 id="editing-users" tabindex="-1"><a class="header-anchor" href="#editing-users" aria-label="Anchor"></a> Editing users</h3><p>A user can be edited by clicking on the <code>Edit</code> button for the user.</p><p><strong>Photo path:</strong> is the path on the file system of the server from where the media of the user is located. Note if running Docker, that this refers to the file system of the container and not the host. Multiple paths can be added, if the media for the user is spread across multiple directories. For more information, see <a href="./usage-scanner">File scanner</a>.</p><p><strong>Admin:</strong> if the user is marked as admin, they will be able to manually start the scanner and to manage and create new users.</p><picture class="block w-full my-8"><source type="image/webp" srcset="/images/-M6yDsgylL-640.webp 640w, /images/-M6yDsgylL-2236.webp 2236w" sizes="100vw"><source type="image/jpeg" srcset="/images/-M6yDsgylL-640.jpeg 640w, /images/-M6yDsgylL-2236.jpeg 2236w" sizes="100vw"><img src="/images/-M6yDsgylL-640.jpeg" alt="screenshot of editing a user"></picture><h2 id="scanner" tabindex="-1"><a class="header-anchor" href="#scanner" aria-label="Anchor"></a> Scanner</h2><h3 id="periodic-scanner" tabindex="-1"><a class="header-anchor" href="#periodic-scanner" aria-label="Anchor"></a> Periodic Scanner</h3><p>When the periodic scanner is enabled, Photoview will automatically scan all users for new media at a fixed time interval.</p><picture class="block w-96 my-8"><source type="image/webp" srcset="/images/Dxrk0J58sY-640.webp 640w, /images/Dxrk0J58sY-872.webp 872w" sizes="100vw"><source type="image/jpeg" srcset="/images/Dxrk0J58sY-640.jpeg 640w, /images/Dxrk0J58sY-872.jpeg 872w" sizes="100vw"><img src="/images/Dxrk0J58sY-640.jpeg" alt="screenshot of periodic scanner"></picture><h3 id="concurrent-workers" tabindex="-1"><a class="header-anchor" href="#concurrent-workers" aria-label="Anchor"></a> Concurrent Workers</h3><p>This setting specifies how many scanner jobs that are allowed to run in the background at once. The lower the value, the longer time it will take to process all media, but the less system resources it will use at once. If you are running Photoview on limited hardware such as a Raspberry Pi, it is recommended to keep this value at 1.</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>