foldergram.github.io/index.html at main · foldergram/foldergram.github.io · GitHub

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
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Foldergram</title>
    <meta name="description" content="Documentation for Foldergram, the local-first photo and video gallery.">
    <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/index.md.CCJ_uVDf.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" 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" 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="VPContent is-home" id="VPContent" data-v-b831c05f data-v-bf3f1372><div class="VPHome" data-v-bf3f1372 data-v-b3d7500e><!--[--><!--]--><div class="VPHero has-image VPHomeHero" data-v-b3d7500e data-v-b285c46d><div class="container" data-v-b285c46d><div class="main" data-v-b285c46d><!--[--><!--]--><!--[--><h1 class="heading" data-v-b285c46d><span class="name clip" data-v-b285c46d>Foldergram</span><span class="text" data-v-b285c46d>Local-first photo and video gallery for folders</span></h1><p class="tagline" data-v-b285c46d>Browse folders you already own through a fast feed-style interface backed by SQLite, generated thumbnails and previews, and a local-only runtime.</p><!--]--><!--[--><!--]--><div class="actions" data-v-b285c46d><!--[--><div class="action" data-v-b285c46d><a class="VPButton medium brand" href="/quick-start" data-v-b285c46d data-v-00677abc>Quick Start</a></div><div class="action" data-v-b285c46d><a class="VPButton medium alt" href="/how-it-works" data-v-b285c46d data-v-00677abc>How It Works</a></div><div class="action" data-v-b285c46d><a class="VPButton medium alt" href="https://foldergram.intentdeep.com/" target="_blank" rel="noreferrer" data-v-b285c46d data-v-00677abc>Live Demo</a></div><!--]--></div><!--[--><!--]--></div><div class="image" data-v-b285c46d><div class="image-container" data-v-b285c46d><div class="image-bg" data-v-b285c46d></div><!--[--><!--[--><img class="VPImage image-src" src="/logo.svg" alt="Foldergram Logo" data-v-84be65fe><!--]--><!--]--></div></div></div></div><!--[--><!--]--><!--[--><!--]--><div class="VPFeatures VPHomeFeatures" data-v-b3d7500e data-v-816c96ea><div class="container" data-v-816c96ea><div class="items" data-v-816c96ea><!--[--><div class="grid-4 item" data-v-816c96ea><div class="VPLink no-icon VPFeature" data-v-816c96ea data-v-da7d3625><!--[--><article class="box" data-v-da7d3625><div class="icon" data-v-da7d3625>🗂️</div><h2 class="title" data-v-da7d3625>Local-first</h2><p class="details" data-v-da7d3625>Originals stay in your configured gallery root. Indexed metadata lives in SQLite and derivatives stay on disk next to the app's local storage paths.</p><!----></article><!--]--></div></div><div class="grid-4 item" data-v-816c96ea><div class="VPLink no-icon VPFeature" data-v-816c96ea data-v-da7d3625><!--[--><article class="box" data-v-da7d3625><div class="icon" data-v-da7d3625>⚡</div><h2 class="title" data-v-da7d3625>Fast feed-style browsing</h2><p class="details" data-v-da7d3625>Runtime reads come from SQLite and generated derivatives instead of filesystem walks during every request.</p><!----></article><!--]--></div></div><div class="grid-4 item" data-v-816c96ea><div class="VPLink no-icon VPFeature" data-v-816c96ea data-v-da7d3625><!--[--><article class="box" data-v-da7d3625><div class="icon" data-v-da7d3625>🖼️</div><h2 class="title" data-v-da7d3625>Photos and videos</h2><p class="details" data-v-da7d3625>Foldergram indexes supported image and video formats, generates thumbnails, creates previews eagerly or lazily, and can expose compatible original MP4 playback in the detail player.</p><!----></article><!--]--></div></div><div class="grid-4 item" data-v-816c96ea><div class="VPLink no-icon VPFeature" data-v-816c96ea data-v-da7d3625><!--[--><article class="box" data-v-da7d3625><div class="icon" data-v-da7d3625>🎯</div><h2 class="title" data-v-da7d3625>Honest scope</h2><p class="details" data-v-da7d3625>The current app includes home feed browsing, folder stories and highlights, a dedicated reels route, explore, library, likes and favorites, moments, optional admin/viewer/public access control, and admin-only maintenance controls without cloud sync or social features.</p><!----></article><!--]--></div></div><!--]--></div></div></div><!--[--><!--]--><div class="vp-doc container" style="" data-v-b3d7500e data-v-b6bb7d79><!--[--><div style="position:relative;" data-v-b3d7500e><div><h2 id="foldergram-at-a-glance" tabindex="-1">Foldergram at a Glance <a class="header-anchor" href="#foldergram-at-a-glance" aria-label="Permalink to &quot;Foldergram at a Glance&quot;"></a></h2><div style="display:grid;grid-template-columns:repeat(auto-fit, minmax(min(420px, 100%), 1fr));gap:1rem;margin:2rem 0;"><div class="cs-feature"><h3>🚀 What ships today</h3><p>The current repository includes Home, Reels, Explore, Library, Likes and Favorites, Moments, folder stories and highlights, Settings, folder pages, a post detail view and modal flow, shared SQLite likes, browser-local favorites in public mode, delete actions, optional admin/viewer/public access control, and local scan/rebuild tooling.</p></div><div class="cs-feature"><h3>🔍 How indexing behaves</h3><p>Foldergram recursively discovers non-hidden folders under <code>GALLERY_ROOT</code>. Any folder that directly contains supported media becomes an indexed album. Files placed directly in the gallery root are ignored.</p></div><div class="cs-feature"><h3>💾 Formats and storage</h3><p>Foldergram indexes images like <code>.jpg</code>, <code>.png</code>, <code>.webp</code>, and <code>.gif</code>, plus videos like <code>.mp4</code>, <code>.mov</code>, <code>.m4v</code>, <code>.webm</code>, and <code>.mkv</code>. Originals stay in the gallery root, SQLite stores indexed metadata, thumbnails are written under <code>thumbnails/</code>, and previews under <code>previews/</code>.</p></div><div class="cs-feature"><h3>🔐 Access modes</h3><p>Foldergram starts without a password gate by default. Settings can enable admin-only access, a separate viewer password, or anonymous public browsing. Once protection is enabled, only admins can open Settings or use Trash, scans, rebuilds, and delete actions.</p></div></div><h2 id="how-foldergram-works" tabindex="-1">How Foldergram Works <a class="header-anchor" href="#how-foldergram-works" aria-label="Permalink to &quot;How Foldergram Works&quot;"></a></h2><div style="display:grid;grid-template-columns:repeat(auto-fit, minmax(min(280px, 100%), 1fr));gap:1rem;margin:2rem 0;"><div class="cs-feature"><h3>1. Discover folders</h3><p>Walk the gallery tree, skip hidden paths, and ignore managed storage paths that would otherwise re-enter the scan.</p></div><div class="cs-feature"><h3>2. Index posts</h3><p>Store normalized paths, media metadata, timestamps, stable sort order, and playback strategy in SQLite.</p></div><div class="cs-feature"><h3>3. Generate derivatives</h3><p>Create `640px` thumbnails, up to `1500px` image previews, and 720p-class video previews. Derivatives can be generated during scans or lazily on first request.</p></div><div class="cs-feature"><h3>4. Serve fast reads</h3><p>Feed, folders, folder stories, likes, moments, and explore read from SQLite and derivative URLs instead of scanning the filesystem on request.</p></div><div class="cs-feature"><h3>5. Build Moments, Highlights, and Stories</h3><p>Home can surface date-based Moments when the library has enough EXIF-backed timestamps, or fall back to Highlights when capture-date coverage is sparse. Reserved <code>AppFolder/stories</code> folders can also power avatar stories and folder highlight circles.</p></div><div class="cs-feature"><h3>6. Maintain the library locally</h3><p>Admins can enable access protection and run manual scans, thumbnail rebuilds, and library-index rebuilds from Settings. If protection is still off, those controls are available immediately to whoever can reach the app.</p></div></div></div></div><!--]--></div></div></div><footer class="VPFooter" 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>