# Frame documentation

> Frame is a private photo-sharing app for close friends. Its open-source server (AGPL-3.0) is one small program and one data folder that you host yourself; these docs cover installing, running, securing and backing it up.

Every page is also available as Markdown at the URLs below (the HTML pages are the same paths without ".md", with a trailing slash). All pages in one file: https://crow.sg/apps/frame/docs/llms-full.txt

## Get started

- [Overview](https://crow.sg/apps/frame/docs/index.md): What a Frame server is, what you need, and which setup to pick.
- [Quickstart](https://crow.sg/apps/frame/docs/quickstart.md): A small server with your own domain, from nothing to your first invite.
- [Set up with an AI agent](https://crow.sg/apps/frame/docs/ai-setup.md): A ready-to-paste prompt that lets a coding agent set the server up with you.

## Install

- [Docker Compose](https://crow.sg/apps/frame/docs/install-docker.md): The official image behind Caddy, a Cloudflare Tunnel or your own proxy.
- [Linux installer (systemd)](https://crow.sg/apps/frame/docs/install-systemd.md): Built-in HTTPS on a VPS, a Pi behind a tunnel, or behind Caddy or nginx.
- [Binary & source](https://crow.sg/apps/frame/docs/install-binary.md): Run the release binary yourself, build from source, or try it locally.

## Run your server

- [First run & admin account](https://crow.sg/apps/frame/docs/first-run.md): The one-time setup link, your admin account and two-factor authentication.
- [Connect the apps & invite](https://crow.sg/apps/frame/docs/connect.md): Point the apps at your server, and decide who can join.
- [Admin panel](https://crow.sg/apps/frame/docs/admin-panel.md): Users, reports, invites and settings, on the web and in the apps.
- [Keep the admin panel private](https://crow.sg/apps/frame/docs/private-admin.md): A local-only panel over SSH, local mode, or no panel at all.
- [Push notifications](https://crow.sg/apps/frame/docs/push.md): How the content-blind relay delivers notifications, and how to turn it off.
- [Storage & sizing](https://crow.sg/apps/frame/docs/storage.md): Local disk or Cloudflare R2, and how much disk, bandwidth and money.
- [Backups & restore](https://crow.sg/apps/frame/docs/backups.md): What to back up, nightly backups, and restoring on a new machine.
- [Upgrading](https://crow.sg/apps/frame/docs/upgrading.md): Updating a systemd or Docker install, and hearing about releases.

## Reference

- [Configuration](https://crow.sg/apps/frame/docs/configuration.md): Every frame.conf setting and the admin command line.
- [Security](https://crow.sg/apps/frame/docs/security.md): What Frame protects, what it doesn't, and a checklist for your server.
- [Troubleshooting](https://crow.sg/apps/frame/docs/troubleshooting.md): Fixes for connection, invite, HTTPS, upload and notification problems.