> A self-hosted drive, in the browser, on your desktop and on your phone. SQLite by default: one container, one volume, no database server to babysit.
> Source: https://orochibraru.com/penombre/canary/docs · Site index: https://orochibraru.com/llms.txt

# Penombre documentation

A self-hosted drive, in the browser, on your desktop and on your phone. SQLite by default: one container, one volume, no database server to babysit.

The Markdown in [the project repo](https://github.com/orochibraru/penombre/tree/main/docs) is the source of truth;
these pages are generated from it.

- [Penombre](https://orochibraru.com/penombre/canary/docs/readme.md): A self-hosted drive. All the convenience of cloud storage, on hardware you own, with a bill of exactly zero.
- [Contributing](https://orochibraru.com/penombre/canary/docs/contributing.md): Unit tests preload test.setup.ts (see bunfig.toml), which mocks $app//#lib/server/ and the Drizzle db object; they need no database or Redis. bunfig.toml also…
- [Getting Started](https://orochibraru.com/penombre/canary/docs/getting-started.md): Spin up a Penombre instance in minutes with Docker Compose.
- [Showcase](https://orochibraru.com/penombre/canary/docs/showcase.md): Every screenshot below is generated by driving a real instance with Playwright (bun run screenshots, or mise run media for these and the feature graphics with…
- [Simple Mode](https://orochibraru.com/penombre/canary/docs/simple-mode.md): Run Penombre as a bare shared file browser instead of a multi-user drive.
- [Environment Variables](https://orochibraru.com/penombre/canary/docs/env.md): Configure your Penombre instance with environment variables.
- [Deployment](https://orochibraru.com/penombre/canary/docs/deployment.md): Deploy Penombre to production with Docker.
- [Reverse Proxy](https://orochibraru.com/penombre/canary/docs/reverse-proxy.md): Expose Penombre behind a reverse proxy with HTTPS.
- [Storage](https://orochibraru.com/penombre/canary/docs/storage.md): Where Penombre keeps your files.
- [Encryption](https://orochibraru.com/penombre/canary/docs/encryption.md): Penombre can seal file bytes at rest with a key you hold, but start with disk-level encryption on DATADIR: for a stolen or decommissioned drive it covers…
- [Mounted volumes](https://orochibraru.com/penombre/canary/docs/volumes.md): A volume is a directory mounted alongside the main drive. It appears in the sidebar as its own entry, is browsable and searchable like any other folder, and is…
- [Worker](https://orochibraru.com/penombre/canary/docs/worker.md): Penombre offloads CPU- and I/O-heavy byte work to a small Go process rather than doing it inline in the app's request handlers.
- [Troubleshooting](https://orochibraru.com/penombre/canary/docs/troubleshooting.md): Solutions to common Penombre issues.
- [Uploads](https://orochibraru.com/penombre/canary/docs/uploads.md): Uploading is deliberately boring: pick files, they land in the folder you are browsing. Two things about it are worth knowing.
- [WebDAV and sync](https://orochibraru.com/penombre/canary/docs/webdav.md): Every Penombre tree is served over WebDAV, so the file manager you already use can mount it and rclone can keep a local folder in sync with it. Penombre Sync…
- [Desktop sync](https://orochibraru.com/penombre/canary/docs/desktop.md): Penombre Sync is a small tray app for macOS, Linux and Windows that keeps folders on your computer in two-way sync with Penombre. It is built on WebDAV and…
- [AI assistants (MCP)](https://orochibraru.com/penombre/canary/docs/mcp.md): Penombre speaks the Model Context Protocol, so an AI assistant can browse, search, read and write your files, and move videos, photos and code in and out to…
- [Mobile app](https://orochibraru.com/penombre/canary/docs/mobile.md): The Penombre app for Android and iOS is at an early stage: it signs in, browses your drive and shared drives, shows pictures, plays music and video, and opens…
- [Media and notes](https://orochibraru.com/penombre/canary/docs/media.md): Images, video and audio get more than a download link.
- [Documents, sheets and presentations](https://orochibraru.com/penombre/canary/docs/documents.md): Penombre creates and edits three kinds of document in the browser, from the New button in the sidebar.
- [Signatures](https://orochibraru.com/penombre/canary/docs/signatures.md): Ask people to sign a document, with or without an account on the instance. Each signer gets a personal link, signs on a page that works on a phone, and once…
- [File versioning](https://orochibraru.com/penombre/canary/docs/versioning.md): Keep the earlier bytes of a file instead of final-final-really.wav.
- [Sharing](https://orochibraru.com/penombre/canary/docs/sharing.md): Penombre shares a file or folder two ways, and the Share dialog has a tab for each:
- [Shared drives](https://orochibraru.com/penombre/canary/docs/shared-drives.md): A shared drive belongs to a group instead of a person. Everyone on it opens the same tree, uploads into the same folders, and sees the same trash — unlike…
- [Notifications](https://orochibraru.com/penombre/canary/docs/notifications.md): The bell in the header tells you when someone else did something to your things. It is deliberately narrow: only events involving another person appear, so your…
- [FAQ](https://orochibraru.com/penombre/canary/docs/faq.md): Settings → General on the web, or Settings → General → Language in the mobile app. Penombre speaks English, French, German, Spanish, Italian, Dutch, Swedish…
- [Admin panel](https://orochibraru.com/penombre/canary/docs/admin.md): Accounts with the admin role get an extra section at /admin, reachable from the user menu. It is hidden entirely when auth is bypassed — nobody signs in under…
- [Authentication](https://orochibraru.com/penombre/canary/docs/authentication.md): Configure authentication methods for your Penombre instance. Penombre supports multiple authentication methods powered by Better Auth.
- [Project architecture](https://orochibraru.com/penombre/canary/docs/architecture.md): Overview of the Penombre project architecture.