Deploying to gh-pages from @ eb44ec7 🚀

en/docs/installation-environment-variables/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="#database-related">Database related</a></li><li><a href="#server-related">Server related</a></li><li><a href="#general">General</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>Environment Variables</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/installation-environment-variables.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/installation-environment-variables/">English</option><option class="lg-switcher-item" value="/fr/docs/installation-environment-variables/">Français</option></select><script>function changeLanguage() {
       document.location.href=document.getElementById("lg-switcher").value;
-    }</script></div></header><p>The Photoview server can be configured through several environment variables. This page presents an index of them all along with a description.</p><h2 id="database-related" tabindex="-1"><a class="header-anchor" href="#database-related" aria-label="Anchor"></a> Database related</h2><p>Environment variables related to configuration of the database.</p><table><thead><tr><th>Required</th><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td></td><td><code>PHOTOVIEW_DATABASE_DRIVER</code></td><td><code>mysql</code></td><td>Available options <code>mysql</code> <small>(default)</small>, <code>postgres</code> and <code>sqlite</code>.<br>Defines what database backend is used. One of the following <strong>MUST</strong> be set in addition to this variable.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_MYSQL_URL</code></td><td></td><td>Required if the driver is <code>mysql</code>. The URL of the MySQL database to connect to. See <a href="https://github.com/go-sql-driver/mysql#dsn-data-source-name">formatting documentation</a>.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_POSTGRES_URL</code></td><td></td><td>Required if the driver is <code>postgres</code>. The connection string of the Postgres database to connect to. See <a href="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING">formatting documentation</a>.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_SQLITE_PATH</code></td><td></td><td>Required if the driver is <code>sqlite</code>. Specifies the filepath for where the sqlite database should be saved.</td></tr></tbody></table><h2 id="server-related" tabindex="-1"><a class="header-anchor" href="#server-related" aria-label="Anchor"></a> Server related</h2><table><thead><tr><th>Required</th><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td></td><td><code>PHOTOVIEW_LISTEN_IP</code></td><td><code>127.0.0.1</code></td><td>The IP for the server to listen on. In most cases can be set to <code>localhost</code>.</td></tr><tr><td></td><td><code>PHOTOVIEW_LISTEN_PORT</code></td><td><code>4001</code></td><td>The port for the server to listen on</td></tr><tr><td></td><td><code>PHOTOVIEW_SERVE_UI</code></td><td><code>0</code></td><td>Set to <code>1</code> for the server to also serve the built static ui files.</td></tr><tr><td></td><td><code>PHOTOVIEW_UI_PATH</code></td><td><code>./ui</code></td><td>Specify where the built UI files are located if <code>PHOTOVIEW_SERVE_UI</code> is enabled.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_API_ENDPOINT</code></td><td></td><td>Used if <code>PHOTOVIEW_SERVE_UI</code> is disabled.<br>The url from where the API can be accessed publicly.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_UI_ENDPOINT</code></td><td></td><td>Used if <code>PHOTOVIEW_SERVE_UI</code> is disabled.<br>The url from where the UI can be accessed publicly.</td></tr></tbody></table><h2 id="general" tabindex="-1"><a class="header-anchor" href="#general" aria-label="Anchor"></a> General</h2><table><thead><tr><th>Required</th><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td></td><td><code>PHOTOVIEW_MEDIA_CACHE</code></td><td><code>./photo_cache</code></td><td>Filepath for where to store generated media such as thumbnails and optimized videos.</td></tr><tr><td></td><td><code>MAPBOX_TOKEN</code></td><td></td><td>To enable map related features, you need to create a mapbox token. A token can be generated for free at <a href="https://account.mapbox.com/access-tokens/">https://account.mapbox.com/access-tokens/</a> It's a good idea to limit the scope of the token to your own domain, to prevent others from using it.</td></tr><tr><td></td><td><code>PHOTOVIEW_DISABLE_FACE_RECOGNITION</code></td><td><code>0</code></td><td>Completely disable face recognition and hide the icon from the side menu.</td></tr><tr><td></td><td><code>PHOTOVIEW_DISABLE_VIDEO_ENCODING</code></td><td><code>0</code></td><td>Disable <code>ffmpeg</code> encoding, but still show web compatiable videos that doesn't need encoding.</td></tr><tr><td></td><td><code>PHOTOVIEW_DISABLE_RAW_PROCESSING</code></td><td><code>0</code></td><td>disable processing of RAW photos using <code>darktable-cli</code>.</td></tr></tbody></table></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>The Photoview server can be configured through several environment variables. This page presents an index of them all along with a description.</p><h2 id="database-related" tabindex="-1"><a class="header-anchor" href="#database-related" aria-label="Anchor"></a> Database related</h2><p>Environment variables related to configuration of the database.</p><table><thead><tr><th>Required</th><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td></td><td><code>PHOTOVIEW_DATABASE_DRIVER</code></td><td><code>mysql</code></td><td>Available options <code>mysql</code> <small>(default)</small>, <code>postgres</code> and <code>sqlite</code>.<br>Defines what database backend is used. One of the following <strong>MUST</strong> be set in addition to this variable.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_MYSQL_URL</code></td><td></td><td>Required if the driver is <code>mysql</code>. The URL of the MySQL database to connect to. See <a href="https://github.com/go-sql-driver/mysql#dsn-data-source-name">formatting documentation</a>.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_POSTGRES_URL</code></td><td></td><td>Required if the driver is <code>postgres</code>. The connection string of the Postgres database to connect to. See <a href="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING">formatting documentation</a>.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_SQLITE_PATH</code></td><td></td><td>Required if the driver is <code>sqlite</code>. Specifies the filepath for where the sqlite database should be saved. Example value: <code>/app/database/photoview.db</code></td></tr></tbody></table><h2 id="server-related" tabindex="-1"><a class="header-anchor" href="#server-related" aria-label="Anchor"></a> Server related</h2><table><thead><tr><th>Required</th><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td></td><td><code>PHOTOVIEW_LISTEN_IP</code></td><td><code>127.0.0.1</code></td><td>The IP for the server to listen on. In most cases can be set to <code>localhost</code>.</td></tr><tr><td></td><td><code>PHOTOVIEW_LISTEN_PORT</code></td><td><code>4001</code></td><td>The port for the server to listen on</td></tr><tr><td></td><td><code>PHOTOVIEW_SERVE_UI</code></td><td><code>0</code></td><td>Set to <code>1</code> for the server to also serve the built static ui files.</td></tr><tr><td></td><td><code>PHOTOVIEW_UI_PATH</code></td><td><code>./ui</code></td><td>Specify where the built UI files are located if <code>PHOTOVIEW_SERVE_UI</code> is enabled.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_API_ENDPOINT</code></td><td></td><td>Used if <code>PHOTOVIEW_SERVE_UI</code> is disabled.<br>The url from where the API can be accessed publicly.</td></tr><tr><td><center>✓</center></td><td><code>PHOTOVIEW_UI_ENDPOINT</code></td><td></td><td>Used if <code>PHOTOVIEW_SERVE_UI</code> is disabled.<br>The url from where the UI can be accessed publicly.</td></tr></tbody></table><h2 id="general" tabindex="-1"><a class="header-anchor" href="#general" aria-label="Anchor"></a> General</h2><table><thead><tr><th>Required</th><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td></td><td><code>PHOTOVIEW_MEDIA_CACHE</code></td><td><code>./photo_cache</code></td><td>Filepath for where to store generated media such as thumbnails and optimized videos.</td></tr><tr><td></td><td><code>MAPBOX_TOKEN</code></td><td></td><td>To enable map related features, you need to create a mapbox token. A token can be generated for free at <a href="https://account.mapbox.com/access-tokens/">https://account.mapbox.com/access-tokens/</a> It's a good idea to limit the scope of the token to your own domain, to prevent others from using it.</td></tr><tr><td></td><td><code>PHOTOVIEW_DISABLE_FACE_RECOGNITION</code></td><td><code>0</code></td><td>Completely disable face recognition and hide the icon from the side menu.</td></tr><tr><td></td><td><code>PHOTOVIEW_DISABLE_VIDEO_ENCODING</code></td><td><code>0</code></td><td>Disable <code>ffmpeg</code> encoding, but still show web compatiable videos that doesn't need encoding.</td></tr><tr><td></td><td><code>PHOTOVIEW_DISABLE_RAW_PROCESSING</code></td><td><code>0</code></td><td>disable processing of RAW photos using <code>darktable-cli</code>.</td></tr></tbody></table></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>