# Framewrk

Framewrk is a self-hosted photo-frame automation tool for people who want Aura and Nixplay digital frames kept filled from their own PhotoPrism or Immich library. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2527/framewrk

## Description

Framewrk is a self-hosted photo-frame automation tool for people who want Aura and Nixplay digital frames kept filled from their own PhotoPrism or Immich library. Point it at PhotoPrism, Immich, or both, add the frames you own, and it uploads the photos that match your rules on a schedule — at the right size and shape for each screen — and takes them back off when they no longer qualify. It remembers what it has already sent, so nothing is uploaded twice. Portrait and landscape frames each get what suits them. Send directly from the Framewrk iOS app or Photos Share Sheet without a photo library. Direct photos are independent of library rules, with delivery history and revocable device tokens. All state is one SQLite file under /data, so a backup is one file.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

59/100 (Fair), based on 4 of 4 factors.
- Maintained: 81 (last commit 38 days ago)
- Popular: 18 (7 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 100 (32 MB minimum RAM, runs on ARM)

## Links

- Docker Hub: https://hub.docker.com/r/smichalczyk/framewrk
- Official website: https://hangframewrk.io/
- Unraid: https://ca.unraid.net/apps/framewrk-0qcsw8m0mbdd96?q=framewrk
- GitHub: https://github.com/smichalczyk/framewrk
- Documentation: https://hangframewrk.io/install.html

## Common questions

### How do I sign in to Framewrk for the first time?

Open the console on port 8770 after the container starts. Find the one-time admin password in the container log, sign in, and choose your own password when asked.

### What do I need before using Aura, Nixplay, or scheduled library sync?

You need an Aura and/or Nixplay account with at least one frame. For scheduled library sync, the PhotoPrism and/or Immich instance must be reachable.

### How should I connect a PhotoPrism or Immich container on the same host?

Put Framewrk and the photo library container on one Docker network and address the library by its container name rather than a changing LAN address. If that still fails, network_mode host can work on Linux, but it ignores ports and puts the console directly on the host's port 8770.

### Can I send photos from the Framewrk iOS app without a connected photo library?

Yes. Direct sends from the iOS app do not require a PhotoPrism or Immich library, but the Framewrk server must be reachable over HTTPS.

### What PUID and PGID setting affects backup access?

Set PUID and PGID in compose.yaml to your own user and group. If you leave them unset, the data folder can end up owned by root, making it harder to read your own backup.

---
Source: Our Local Host (https://ourlocalhost.com/app/2527/framewrk), the self-hosted and open-source app directory.
