-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconfiguration.html
More file actions
57 lines (55 loc) · 34.5 KB
/
configuration.html
File metadata and controls
57 lines (55 loc) · 34.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Configuration | Foldergram</title>
<meta name="description" content="Environment variables, path rules, and scan concurrency controls in Foldergram.">
<meta name="generator" content="VitePress v1.6.4">
<link rel="preload stylesheet" href="/assets/style.D0ri7LhZ.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.Ctsaibyu.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.DJE1TC2M.js">
<link rel="modulepreload" href="/assets/chunks/framework.ePeAWSvT.js">
<link rel="modulepreload" href="/assets/configuration.md.BsBeukw7.lean.js">
<link rel="icon" type="image/svg+xml" href="/logo.svg">
<link rel="apple-touch-icon" href="/logo.svg">
<meta name="theme-color" content="#6366f1">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-b831c05f><!--[--><!--]--><!--[--><span tabindex="-1" data-v-9178e81a></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-9178e81a>Skip to content</a><!--]--><!----><header class="VPNav" data-v-b831c05f data-v-2222ab16><div class="VPNavBar" data-v-2222ab16 data-v-3a1adb31><div class="wrapper" data-v-3a1adb31><div class="container" data-v-3a1adb31><div class="title" data-v-3a1adb31><div class="VPNavBarTitle has-sidebar" data-v-3a1adb31 data-v-7c1b0e18><a class="title" href="/" data-v-7c1b0e18><!--[--><!--]--><!--[--><img class="VPImage logo" src="/logo.svg" alt data-v-84be65fe><!--]--><span data-v-7c1b0e18>Foldergram</span><!--[--><!--]--></a></div></div><div class="content" data-v-3a1adb31><div class="content-body" data-v-3a1adb31><!--[--><!--]--><div class="VPNavBarSearch search" data-v-3a1adb31><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-3a1adb31 data-v-b187e594><span id="main-nav-aria-label" class="visually-hidden" data-v-b187e594> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/quick-start" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>Quick Start</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/installation" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>Installation</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/configuration" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>Configuration</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/how-it-works" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>How It Works</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/api" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>API</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/security" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>Security</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://foldergram.intentdeep.com/" target="_blank" rel="noreferrer" tabindex="0" data-v-b187e594 data-v-4599aa41><!--[--><span data-v-4599aa41>Demo</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-3a1adb31 data-v-df187b99><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-df187b99 data-v-8e7bc7a0 data-v-dc0f6ec6><span class="check" data-v-dc0f6ec6><span class="icon" data-v-dc0f6ec6><!--[--><span class="vpi-sun sun" data-v-8e7bc7a0></span><span class="vpi-moon moon" data-v-8e7bc7a0></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-3a1adb31 data-v-ed584c66 data-v-2b546b40><!--[--><a class="VPSocialLink no-icon" href="https://github.com/foldergram/foldergram" aria-label="github" target="_blank" rel="noopener" data-v-2b546b40 data-v-9ca19b6a><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-3a1adb31 data-v-7fd1485d data-v-5d90fd5a><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-5d90fd5a><span class="vpi-more-horizontal icon" data-v-5d90fd5a></span></button><div class="menu" data-v-5d90fd5a><div class="VPMenu" data-v-5d90fd5a data-v-565e72ed><!----><!--[--><!--[--><!----><div class="group" data-v-7fd1485d><div class="item appearance" data-v-7fd1485d><p class="label" data-v-7fd1485d>Appearance</p><div class="appearance-action" data-v-7fd1485d><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-7fd1485d data-v-8e7bc7a0 data-v-dc0f6ec6><span class="check" data-v-dc0f6ec6><span class="icon" data-v-dc0f6ec6><!--[--><span class="vpi-sun sun" data-v-8e7bc7a0></span><span class="vpi-moon moon" data-v-8e7bc7a0></span><!--]--></span></span></button></div></div></div><div class="group" data-v-7fd1485d><div class="item social-links" data-v-7fd1485d><div class="VPSocialLinks social-links-list" data-v-7fd1485d data-v-2b546b40><!--[--><a class="VPSocialLink no-icon" href="https://github.com/foldergram/foldergram" aria-label="github" target="_blank" rel="noopener" data-v-2b546b40 data-v-9ca19b6a><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-3a1adb31 data-v-7b1e48c5><span class="container" data-v-7b1e48c5><span class="top" data-v-7b1e48c5></span><span class="middle" data-v-7b1e48c5></span><span class="bottom" data-v-7b1e48c5></span></span></button></div></div></div></div><div class="divider" data-v-3a1adb31><div class="divider-line" data-v-3a1adb31></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-b831c05f data-v-a3b82d7b><div class="container" data-v-a3b82d7b><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a3b82d7b><span class="vpi-align-left menu-icon" data-v-a3b82d7b></span><span class="menu-text" data-v-a3b82d7b>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a3b82d7b data-v-84597ab5><button data-v-84597ab5>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-b831c05f data-v-e0bd508c><div class="curtain" data-v-e0bd508c></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-e0bd508c><span class="visually-hidden" id="sidebar-aria-label" data-v-e0bd508c> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-aef8ce5e><section class="VPSidebarItem level-0 has-active" data-v-aef8ce5e data-v-44dbf5ab><div class="item" role="button" tabindex="0" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><h2 class="text" data-v-44dbf5ab>Guide</h2><!----></div><div class="items" data-v-44dbf5ab><!--[--><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/quick-start" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Quick Start</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/installation" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Installation</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/configuration" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Configuration</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-aef8ce5e><section class="VPSidebarItem level-0" data-v-aef8ce5e data-v-44dbf5ab><div class="item" role="button" tabindex="0" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><h2 class="text" data-v-44dbf5ab>Product</h2><!----></div><div class="items" data-v-44dbf5ab><!--[--><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/how-it-works" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>How It Works</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/features" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Features</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/media-processing" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Media Processing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/security" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Security</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-aef8ce5e><section class="VPSidebarItem level-0" data-v-aef8ce5e data-v-44dbf5ab><div class="item" role="button" tabindex="0" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><h2 class="text" data-v-44dbf5ab>Reference</h2><!----></div><div class="items" data-v-44dbf5ab><!--[--><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/api" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/development" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Development</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/troubleshooting" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>Troubleshooting</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-44dbf5ab data-v-44dbf5ab><div class="item" data-v-44dbf5ab><div class="indicator" data-v-44dbf5ab></div><a class="VPLink link link" href="/faq" data-v-44dbf5ab><!--[--><p class="text" data-v-44dbf5ab>FAQ</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-b831c05f data-v-bf3f1372><div class="VPDoc has-sidebar has-aside" data-v-bf3f1372 data-v-7c2da6bf><!--[--><!--]--><div class="container" data-v-7c2da6bf><div class="aside" data-v-7c2da6bf><div class="aside-curtain" data-v-7c2da6bf></div><div class="aside-container" data-v-7c2da6bf><div class="aside-content" data-v-7c2da6bf><div class="VPDocAside" data-v-7c2da6bf data-v-c3c6bcbc><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-c3c6bcbc data-v-16b74dc6><div class="content" data-v-16b74dc6><div class="outline-marker" data-v-16b74dc6></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-16b74dc6>On this page</div><ul class="VPDocOutlineItem root" data-v-16b74dc6 data-v-8c1c05d6><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-c3c6bcbc></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-7c2da6bf><div class="content-container" data-v-7c2da6bf><!--[--><!--]--><main class="main" data-v-7c2da6bf><div style="position:relative;" class="vp-doc _configuration" data-v-7c2da6bf><div><h1 id="configuration" tabindex="-1">Configuration <a class="header-anchor" href="#configuration" aria-label="Permalink to "Configuration""></a></h1><p>For source installs, Foldergram reads <code>.env</code> from the repository root and validates it in <code>server/src/config/env.ts</code>.</p><p>In the default Docker Compose setup, the container uses the image's built-in production defaults plus the mounted <code>./data/...</code> volumes. The source-install <code>.env</code> file is not read directly inside the container unless you wire that in yourself.</p><h2 id="environment-variables" tabindex="-1">Environment variables <a class="header-anchor" href="#environment-variables" aria-label="Permalink to "Environment variables""></a></h2><table tabindex="0"><thead><tr><th>Variable</th><th>Default</th><th>Notes</th></tr></thead><tbody><tr><td><code>NODE_ENV</code></td><td><code>development</code></td><td>Must be <code>development</code>, <code>test</code>, or <code>production</code>.</td></tr><tr><td><code>SERVER_PORT</code></td><td><code>4141</code></td><td>Production Express port. Used by Docker and <code>pnpm start</code>.</td></tr><tr><td><code>DEV_SERVER_PORT</code></td><td><code>4140</code></td><td>Express server port during <code>pnpm dev</code>.</td></tr><tr><td><code>DEV_CLIENT_PORT</code></td><td><code>4141</code></td><td>Base Vite dev server port during <code>pnpm dev</code>. The client may fall forward through <code>4144</code>. The same range is allowed for non-production local-origin mutation checks.</td></tr><tr><td><code>DATA_ROOT</code></td><td><code>./data</code></td><td>Base directory for app-managed storage. Other storage paths default under it unless overridden.</td></tr><tr><td><code>DATA_DIR</code></td><td>unset</td><td>Optional alias that falls back into <code>DATA_ROOT</code> resolution when <code>DATA_ROOT</code> is absent.</td></tr><tr><td><code>GALLERY_ROOT</code></td><td><code>./data/gallery</code></td><td>Source media root. Foldergram scans below this path.</td></tr><tr><td><code>DB_DIR</code></td><td><code>./data/db</code></td><td>SQLite directory. Database file is <code>gallery.sqlite</code>.</td></tr><tr><td><code>THUMBNAILS_DIR</code></td><td><code>./data/thumbnails</code></td><td>Generated thumbnail output root.</td></tr><tr><td><code>PREVIEWS_DIR</code></td><td><code>./data/previews</code></td><td>Generated preview output root.</td></tr><tr><td><code>IMAGE_DETAIL_SOURCE</code></td><td><code>preview</code></td><td>For image detail pages, use generated previews or stream originals. Videos ignore this flag.</td></tr><tr><td><code>DERIVATIVE_MODE</code></td><td><code>eager</code></td><td>Generate derivatives during scans or lazily on the first protected derivative request.</td></tr><tr><td><code>LOG_VERBOSE</code></td><td><code>0</code></td><td>Truthy values are <code>1</code>, <code>true</code>, <code>yes</code>, and <code>on</code>.</td></tr><tr><td><code>SCAN_DISCOVERY_CONCURRENCY</code></td><td><code>4</code></td><td>Discovery concurrency, validated from <code>1</code> to <code>32</code>.</td></tr><tr><td><code>SCAN_DERIVATIVE_CONCURRENCY</code></td><td><code>4</code></td><td>Derivative concurrency, validated from <code>1</code> to <code>32</code>.</td></tr><tr><td><code>PUBLIC_DEMO_MODE</code></td><td><code>0</code></td><td>When enabled, mutating API routes return <code>403</code> for read-only demo deployments.</td></tr><tr><td><code>CSRF_TRUSTED_ORIGINS</code></td><td>unset</td><td>Comma-separated extra browser origins allowed for mutating API requests. Useful behind reverse proxies or HTTPS terminators.</td></tr></tbody></table><h2 id="access-protection-configuration" tabindex="-1">Access protection configuration <a class="header-anchor" href="#access-protection-configuration" aria-label="Permalink to "Access protection configuration""></a></h2><p>Shared-password protection is <strong>not</strong> configured in <code>.env</code>.</p><p>Instead:</p><ul><li>enable it from the Settings page</li><li>Foldergram stores the password hash and session metadata in SQLite <code>app_settings</code></li><li>deleting or replacing the SQLite database resets the configured password protection state</li></ul><p>The built-in auth model is a small role-based password gate for one app instance, not a multi-user account system.</p><h2 id="stories-folders-mode" tabindex="-1">Stories folders mode <a class="header-anchor" href="#stories-folders-mode" aria-label="Permalink to "Stories folders mode""></a></h2><p>Reserved stories behavior is <strong>not</strong> configured in <code>.env</code>.</p><p>Instead:</p><ul><li>Foldergram stores the current stories-folders mode in SQLite <code>app_settings</code></li><li>the Settings page exposes the toggle <code>Treat stories folders as normal app folders</code></li><li>the default mode is reserved stories, where <code>AppFolder/stories</code> powers avatar stories and highlight capsules</li><li>turning the toggle on enables legacy behavior, where folders literally named <code>stories</code> remain ordinary app folders</li><li>changing this setting requires a rescan because the indexed folder structure changes</li><li>if the existing library already contains candidate <code>stories/</code> folders, Settings can show a migration decision card until you choose a mode</li></ul><h2 id="path-resolution-rules" tabindex="-1">Path resolution rules <a class="header-anchor" href="#path-resolution-rules" aria-label="Permalink to "Path resolution rules""></a></h2><ul><li><code>DATA_ROOT</code> is the common fallback parent for the app's storage directories.</li><li>If you set only <code>DATA_ROOT=/mnt/foldergram</code>, the default paths become <code>/mnt/foldergram/gallery</code>, <code>/mnt/foldergram/db</code>, <code>/mnt/foldergram/thumbnails</code>, and <code>/mnt/foldergram/previews</code>.</li><li>Setting <code>GALLERY_ROOT</code>, <code>DB_DIR</code>, <code>THUMBNAILS_DIR</code>, or <code>PREVIEWS_DIR</code> overrides only that specific path.</li><li><code>DATA_DIR</code> is a legacy alias. It is used only when <code>DATA_ROOT</code> is unset.</li><li>Relative paths are resolved from the repository root.</li><li>Absolute paths are used as-is.</li><li><code>THUMBNAILS_DIR</code> and <code>PREVIEWS_DIR</code> must be separate, non-overlapping directories.</li><li><code>THUMBNAILS_DIR</code> cannot contain <code>GALLERY_ROOT</code>.</li><li><code>PREVIEWS_DIR</code> cannot contain <code>GALLERY_ROOT</code>.</li></ul><p>Foldergram normalizes path separators so the same rules work with POSIX-style and Windows-style paths.</p><h2 id="detail-source-and-derivative-timing" tabindex="-1">Detail source and derivative timing <a class="header-anchor" href="#detail-source-and-derivative-timing" aria-label="Permalink to "Detail source and derivative timing""></a></h2><h3 id="image-detail-source" tabindex="-1"><code>IMAGE_DETAIL_SOURCE</code> <a class="header-anchor" href="#image-detail-source" aria-label="Permalink to "`IMAGE_DETAIL_SOURCE`""></a></h3><p>Accepted values:</p><ul><li><code>preview</code></li><li><code>original</code></li></ul><p>Behavior:</p><ul><li>applies to image detail pages only</li><li><code>preview</code> keeps <code>/image/:id</code> on generated preview assets</li><li><code>original</code> makes image detail pages use <code>/api/originals/:id</code></li><li>does not change feed cards, folder grids, avatars, or other list surfaces</li><li>does not change video default playback behavior</li></ul><h3 id="derivative-mode" tabindex="-1"><code>DERIVATIVE_MODE</code> <a class="header-anchor" href="#derivative-mode" aria-label="Permalink to "`DERIVATIVE_MODE`""></a></h3><p>Accepted values:</p><ul><li><code>eager</code></li><li><code>lazy</code></li></ul><p>Behavior:</p><ul><li><code>eager</code> generates thumbnails and previews during scans</li><li><code>lazy</code> still indexes metadata during scans, but missing files are generated on the first request to <code>/thumbnails/...</code> or <code>/previews/...</code> and then cached on disk</li><li>lazy mode applies to thumbnails and previews</li><li>lazy mode keeps derivative URLs deterministic because the indexed relative derivative paths are still stored in SQLite</li></ul><h3 id="recommended-combinations" tabindex="-1">Recommended combinations <a class="header-anchor" href="#recommended-combinations" aria-label="Permalink to "Recommended combinations""></a></h3><table tabindex="0"><thead><tr><th>Goal</th><th>Suggested config</th></tr></thead><tbody><tr><td>Current behavior</td><td><code>IMAGE_DETAIL_SOURCE=preview</code>, <code>DERIVATIVE_MODE=eager</code></td></tr><tr><td>Lowest upfront processing for large libraries</td><td><code>IMAGE_DETAIL_SOURCE=original</code>, <code>DERIVATIVE_MODE=lazy</code></td></tr></tbody></table><h3 id="settings-actions-and-lazy-mode" tabindex="-1">Settings actions and lazy mode <a class="header-anchor" href="#settings-actions-and-lazy-mode" aria-label="Permalink to "Settings actions and lazy mode""></a></h3><ul><li><code>Scan Library</code> always refreshes index metadata.</li><li><code>Rebuild Library Index</code> resets and rebuilds the SQLite-backed index, then reuses any matching derivatives already on disk.</li><li>In <code>DERIVATIVE_MODE=lazy</code>, neither a normal scan nor <code>Rebuild Library Index</code> pre-generates missing thumbnails or previews.</li><li><code>Regenerate Thumbnails</code> remains a manual thumbnail and video-poster rebuild only. It does not rebuild previews.</li></ul><h2 id="managed-path-ignores" tabindex="-1">Managed path ignores <a class="header-anchor" href="#managed-path-ignores" aria-label="Permalink to "Managed path ignores""></a></h2><p>If your configured database, thumbnails, or previews directories live inside the gallery tree, Foldergram computes their relative paths and excludes them from discovery. That prevents generated files from being re-indexed as source media.</p><h2 id="recommended-local-env" tabindex="-1">Recommended local <code>.env</code> <a class="header-anchor" href="#recommended-local-env" aria-label="Permalink to "Recommended local `.env`""></a></h2><p><code>.env.example</code> groups the main runtime settings in the same order shown above. Production runtimes still use <code>SERVER_PORT</code>, which defaults to <code>4141</code> unless you override it in Docker Compose or at process start.</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">NODE_ENV</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">development</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SERVER_PORT</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">4141</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DEV_SERVER_PORT</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">4140</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DEV_CLIENT_PORT</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">4141</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DATA_ROOT</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">./data</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">GALLERY_ROOT</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">./data/gallery</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DB_DIR</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">./data/db</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">THUMBNAILS_DIR</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">./data/thumbnails</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">PREVIEWS_DIR</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">./data/previews</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">IMAGE_DETAIL_SOURCE</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">preview</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DERIVATIVE_MODE</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">eager</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">LOG_VERBOSE</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">0</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SCAN_DISCOVERY_CONCURRENCY</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">4</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SCAN_DERIVATIVE_CONCURRENCY</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">4</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">PUBLIC_DEMO_MODE</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">0</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">CSRF_TRUSTED_ORIGINS</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span></span></code></pre></div><h2 id="concurrency-tuning" tabindex="-1">Concurrency tuning <a class="header-anchor" href="#concurrency-tuning" aria-label="Permalink to "Concurrency tuning""></a></h2><p><code>SCAN_DISCOVERY_CONCURRENCY</code> affects filesystem stat and metadata discovery work. <code>SCAN_DERIVATIVE_CONCURRENCY</code> affects Sharp and FFmpeg jobs.</p><p>Practical guidance:</p><ul><li>Keep the defaults on smaller machines.</li><li>Increase discovery concurrency only when storage is fast enough to benefit.</li><li>Increase derivative concurrency only when CPU, RAM, and disk bandwidth can handle it.</li></ul><h2 id="gallery-structure-expectations" tabindex="-1">Gallery structure expectations <a class="header-anchor" href="#gallery-structure-expectations" aria-label="Permalink to "Gallery structure expectations""></a></h2><p>Foldergram ignores files placed directly in <code>GALLERY_ROOT</code>.</p><p>It indexes only folders that directly contain supported media:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>gallery/</span></span>
<span class="line"><span> loose-file.jpg # ignored</span></span>
<span class="line"><span> trips/</span></span>
<span class="line"><span> oslo/</span></span>
<span class="line"><span> IMG_0001.jpg # indexed folder</span></span>
<span class="line"><span> berlin/</span></span>
<span class="line"><span> notes.txt # not indexed</span></span></code></pre></div><p>In the default reserved-stories mode, Foldergram also treats <code>AppFolder/stories</code> specially:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>gallery/</span></span>
<span class="line"><span> AnimalPlanet/</span></span>
<span class="line"><span> post-1.jpg # indexed owner folder media</span></span>
<span class="line"><span> stories/</span></span>
<span class="line"><span> story-1.mp4 # avatar story set</span></span>
<span class="line"><span> Lions/</span></span>
<span class="line"><span> clip-1.mp4 # highlight capsule</span></span>
<span class="line"><span> nested-1/</span></span>
<span class="line"><span> clip-2.jpg # still part of Lions</span></span></code></pre></div><p>If you want folders literally named <code>stories</code> to remain ordinary app folders, enable <code>Treat stories folders as normal app folders</code> in Settings and rescan the library.</p><h2 id="gallery-root-changes" tabindex="-1">Gallery root changes <a class="header-anchor" href="#gallery-root-changes" aria-label="Permalink to "Gallery root changes""></a></h2><p>Foldergram stores the last successful gallery root in <code>app_settings</code>.</p><p>When the configured gallery root changes and there is already indexed content, Foldergram marks the library as requiring a rebuild. Until that rebuild happens:</p><ul><li>startup scanning is deferred</li><li>manual rescans return <code>409</code></li><li>thumbnail rebuilds return <code>409</code></li></ul><p>Viewer-safe shell status comes from <code>GET /api/status</code>.</p><p>The current and previous gallery roots remain exposed only in <code>GET /api/admin/stats</code>.</p></div></div></main><footer class="VPDocFooter" data-v-7c2da6bf data-v-fea9e177><!--[--><!--]--><div class="edit-info" data-v-fea9e177><!----><div class="last-updated" data-v-fea9e177><p class="VPLastUpdated" data-v-fea9e177 data-v-61bce6e2>Last updated: <time datetime="2026-03-28T17:40:54.000Z" data-v-61bce6e2></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-fea9e177><span class="visually-hidden" id="doc-footer-aria-label" data-v-fea9e177>Pager</span><div class="pager" data-v-fea9e177><a class="VPLink link pager-link prev" href="/installation" data-v-fea9e177><!--[--><span class="desc" data-v-fea9e177>Previous page</span><span class="title" data-v-fea9e177>Installation</span><!--]--></a></div><div class="pager" data-v-fea9e177><a class="VPLink link pager-link next" href="/how-it-works" data-v-fea9e177><!--[--><span class="desc" data-v-fea9e177>Next page</span><span class="title" data-v-fea9e177>How It Works</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-b831c05f data-v-9f6e1f5c><div class="container" data-v-9f6e1f5c><p class="message" data-v-9f6e1f5c>Released under the AGPL-3.0 License.</p><p class="copyright" data-v-9f6e1f5c>Copyright © 2026 Sajjad Ali</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api.md\":\"Dq0npsCa\",\"configuration.md\":\"BsBeukw7\",\"development.md\":\"C4QAiDqM\",\"faq.md\":\"BhPUjBTn\",\"features.md\":\"C4hW69V4\",\"how-it-works.md\":\"CLbxPRcv\",\"index.md\":\"CCJ_uVDf\",\"installation.md\":\"BJPcu2wc\",\"media-processing.md\":\"BZnAue5X\",\"quick-start.md\":\"Bi2ZqhxJ\",\"security.md\":\"BwkL2X-x\",\"troubleshooting.md\":\"c84mph4l\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Foldergram\",\"description\":\"Documentation for Foldergram, the local-first photo and video gallery.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/logo.svg\",\"siteTitle\":\"Foldergram\",\"search\":{\"provider\":\"local\"},\"nav\":[{\"text\":\"Quick Start\",\"link\":\"/quick-start\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"How It Works\",\"link\":\"/how-it-works\"},{\"text\":\"API\",\"link\":\"/api\"},{\"text\":\"Security\",\"link\":\"/security\"},{\"text\":\"Demo\",\"link\":\"https://foldergram.intentdeep.com/\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/foldergram/foldergram\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Quick Start\",\"link\":\"/quick-start\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"}]},{\"text\":\"Product\",\"items\":[{\"text\":\"How It Works\",\"link\":\"/how-it-works\"},{\"text\":\"Features\",\"link\":\"/features\"},{\"text\":\"Media Processing\",\"link\":\"/media-processing\"},{\"text\":\"Security\",\"link\":\"/security\"}]},{\"text\":\"Reference\",\"items\":[{\"text\":\"API\",\"link\":\"/api\"},{\"text\":\"Development\",\"link\":\"/development\"},{\"text\":\"Troubleshooting\",\"link\":\"/troubleshooting\"},{\"text\":\"FAQ\",\"link\":\"/faq\"}]}],\"outline\":{\"level\":[2,3],\"label\":\"On this page\"},\"footer\":{\"message\":\"Released under the AGPL-3.0 License.\",\"copyright\":\"Copyright © 2026 Sajjad Ali\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
</body>
</html>