# What is Frameleaf?

Source: https://frameleaf.app/docs/start/introduction/

Frameleaf is a photo and video library you run on your own hardware: a NAS, a home server or any Linux machine with Docker. Your phones back up to it, your family shares it, and the originals stay on your disks as ordinary files.

It's built for home and family libraries: Google Photos-style discovery, with faces and search worked out on your own server, and fast Cloud processing for heavy tasks whenever you approve it.

[Frameleaf Manager](https://frameleaf.app/docs/start/install/) installs it for you: it checks your server, helps you choose folders and drives, and afterwards looks after updates, database backups and recovery. Experienced administrators can use [manual Docker Compose setup](https://frameleaf.app/docs/start/manual-install/) instead.

## The three parts

- **The server**, which stores your library, recognises faces, powers search and serves the web app. The open-source edition is the **Frameleaf Library community edition**, licensed under AGPLv3.
- **The apps** for [iPhone and iPad](https://frameleaf.app/docs/apps/iphone/) and [Android](https://frameleaf.app/docs/apps/android/), which back up your camera roll and browse the whole library. [Apple TV](https://frameleaf.app/docs/apps/apple-tv/) and [Android TV](https://frameleaf.app/docs/apps/android-tv/) bring your library to your television, and [Frameleaf Desktop](https://frameleaf.app/docs/apps/desktop/) opens your library on a Mac, Windows PC or Linux computer, where it can also lend that computer to the server's AI work. The [iPhone Duo guide](https://frameleaf.app/docs/apps/iphone-duo/) explains the developing foldable layouts.
- **Frameleaf Cloud**, an optional plan that lets you reach your library from anywhere, keeps 1 TB of off-site backup, adds the relay for buddy backup with a friend (over a direct connection, buddy backup needs only Server licences), Sign in with Frameleaf for your family, and the Apple TV app. Cloud GPU uses wallet credit and doesn't need a plan. Your local library works fully on its own. See [Frameleaf Cloud](https://frameleaf.app/docs/cloud/overview/).

## What's inside the server

A Frameleaf installation is a small group of Docker containers. Manager creates and updates them for you; a manual installation starts them from one Compose file.

| Container | What it does |
| --- | --- |
| Server | The server, the web app and the API. Listens on port `2283`, and on `2443` for direct [Frameleaf Cloud remote access](https://frameleaf.app/docs/cloud/remote-access/). |
| Machine learning | Face recognition, smart search and other models that run on your own server. It also runs the worker that lets Studio open and export in the browser. |
| Database | PostgreSQL, which holds your albums, people, descriptions, settings and background jobs. There's no Redis to run. |
| Network discovery | A small helper that lets the phone apps find the server on your Wi-Fi. It has no access to your photos or the database. |

In a manual installation the first three are called `frameleaf_server`, `frameleaf_machine_learning` and `frameleaf_postgres`. Manager gives each installation its own container names and shows them on its [Containers](https://frameleaf.app/docs/admin/manager/#containers) page.

Your photos and videos live in one folder on the server, and the database lives in another, ideally on a fast drive. With Manager you choose both during setup and can [move them later](https://frameleaf.app/docs/admin/move-data-to-another-drive/). In a manual installation they're set by `UPLOAD_LOCATION` and `DB_DATA_LOCATION`.

## What you get

Everything you'd expect from a family photo service, plus a lot that's unique to Frameleaf:

- **Backup and browsing** on phone and web, with a timeline, albums, shared albums, partners and public links.
- **Search in plain words**, such as "photos of Alice in Calgary from April 2024", with faces, places and dates worked out on your server.
- **People and pets**, memories and a world map.
- **Locked content**: keep sensitive photos (medical, financial, identity documents) in your normal albums but hidden behind your PIN.
- **AI descriptions and tags** for photos and videos, written by a model on your own server, with smart albums that fill themselves.
- **Nested albums** with folders, custom icons and drag-and-drop ordering, and [Boards](https://frameleaf.app/docs/using/boards/) for collecting and arranging.
- **Non-destructive editing** for photos and videos, and **Studio**, a multitrack video editor.
- **Library Care** to find missing and damaged originals and put back verified copies.
- **Duplicate review** that keeps your HEIC or RAW original rather than a bigger re-encoded JPG, and physical deduplication so a family doesn't store the same file twice.
- **Imports** from Google Photos, iCloud Photos and other photo apps, and a verified server-to-server move.

See the [features overview](https://frameleaf.app/docs/start/features/) for the full list.

:::caution[Keep your own backups]
Frameleaf looks after your library carefully, but no software can stop a disk from failing. Follow a 3-2-1 backup plan: three copies, on two kinds of storage, with one off-site. See [Backup and restore](https://frameleaf.app/docs/admin/backup-and-restore/).
:::

## Where to start

1. Check the [requirements](https://frameleaf.app/docs/start/requirements/).
2. On Synology, [install the native app through Package Center](https://frameleaf.app/docs/nas/synology/). On other hosts, [install with Frameleaf Manager](https://frameleaf.app/docs/start/install/) or follow the [Unraid](https://frameleaf.app/docs/nas/unraid/), [TrueNAS](https://frameleaf.app/docs/nas/truenas/) or [HexOS](https://frameleaf.app/docs/nas/hexos/) guide. Manual options are in [Other ways to install](https://frameleaf.app/docs/start/other-install-methods/).
3. Open the web app and work through [first steps](https://frameleaf.app/docs/start/first-steps/): your local admin account, an optional Frameleaf account, other people, your phone and backups.
4. Bring in the rest of your photos from [Google Photos](https://frameleaf.app/docs/migrate/google-photos/), [iCloud Photos](https://frameleaf.app/docs/migrate/icloud-photos/) or an existing folder with an [external library](https://frameleaf.app/docs/admin/external-libraries/).

Bringing an existing collection? See [Bring an existing library](https://frameleaf.app/docs/migrate/from-another-library/).
