# ImmichFrame

> Turn a tablet or TV into a photo frame for your Immich photos.

- Page: https://cgt.octabyte.io/templates/immichframe/
- Category: Files & photos
- Replaces: Nixplay and Aura Frames
- Ease of use: Some setup. Enter your Immich address and an Immich API key during setup, pick photos on the admin page, then open the frame's address on each screen and enter its access secret once.
- App price: Free. To run it you need Cloudgate (hosted, or free to install yourself) and a server, which hosted Cloudgate can provide.
- License: GPL-3.0-only
- Good for: Families and offices with photos in Immich who want a slideshow on a tablet, TV or wall screen
- Official website: https://immichframe.dev
- Documentation: https://immichframe.dev/docs/overview
- Source code: https://github.com/immichFrame/ImmichFrame
- Last updated: 2026-11-20

## What is ImmichFrame?

ImmichFrame is a self-hosted digital photo frame for Immich: it turns a tablet, TV or spare screen into a slideshow of your albums, with clock and weather.

ImmichFrame is a free, open-source digital photo frame for Immich, the self-hosted photo library, and an alternative to cloud photo frames such as Nixplay and Aura. It turns a tablet, TV, wall screen or any web browser into a slideshow of the photos you choose from your Immich server, with the time, the weather and upcoming calendar events on top.

You pick what appears: certain albums, the people you want to see, favourites, "on this day" memories or recent photos. Each picture can show where and when it was taken and who is in it, and upright photos can be paired on a wide screen. A family could, for example, mount an old tablet in the hallway showing the "Family" album and today's weather, while a small office runs a TV in reception with photos from team events.

ImmichFrame needs your own Immich server, which is also in the Cloudgate catalogue. It is a community project, not made by the Immich team, and it reads your photos from Immich rather than keeping its own copies. There are free apps for Apple TV, iPhone, iPad and Android, including an Android TV screensaver.

Cloudgate installs ImmichFrame on a server Cloudgate provides or one you connect and gives it a secure web address. You enter your Immich address and an API key during setup, and Cloudgate generates the admin password for the /admin page and an access secret that each screen enters once, so the address is not an open window onto your photos.

## What you can do with ImmichFrame

- **Use a screen you already have**: Show the slideshow on an old tablet, a wall screen, a Raspberry Pi, a TV, or any device with a web browser.
- **Pick which photos appear**: Choose albums, people, favourites, "on this day" memories, a date range or recent photos, and leave out albums you want kept off the wall.
- **Clock, weather and calendar**: Show the time, the local weather and your upcoming calendar events over the photos.
- **The story behind each photo**: Show where and when each photo was taken, its description and who is in it.
- **Two portraits side by side**: Upright photos can be paired on a wide screen, with a gentle zoom or pan to bring them to life.
- **Apps for TVs and phones**: Free apps for Apple TV, iPhone and iPad, and Android, which can also run as the screensaver on an Android TV.
- **Change settings in the browser**: An admin page lets you change every setting and add Immich accounts with no restart; screens pick up new display settings the next time they load.

## Replaces Nixplay and Aura Frames

ImmichFrame does the same job as Nixplay and Aura Frames. Here is what changes when you switch.

### What you gain

- No frame to buy and no cloud storage plan; any screen you own will do
- Your photos stay on your own Immich server
- The frame updates by itself as you add photos to an album in Immich

### What is different

- You need your own Immich server running first
- Setup takes a few steps, where a store-bought frame works out of the box
- Weather needs a free key from OpenWeatherMap
- A community project, not made by the Immich team

## What happens when you click Deploy?

Deploy link: https://cloudgate.octabyte.app/get-started?template=immichframe

1. **Click Deploy and create your account.** Deploy takes you to Cloudgate. Create an account, or log in if you have one. ImmichFrame itself is free.
2. **Choose a server.** No server? Get one from Cloudgate: pick a size and a country, and Cloudgate gets it ready. Already have one? Connect it instead.
3. **Cloudgate sets up ImmichFrame.** It prepares the server, makes the passwords the app needs and starts it. There is nothing to install and nothing to write down.
4. **Open your app and sign in.** Your app gets a free web address to start, without https. Add your own domain, like app.yourshop.com, and Cloudgate secures it with https for you.

## Questions

### Is ImmichFrame free?

Yes. ImmichFrame is free, open-source software under the GPL-3.0 licence, and its apps are free too. You pay only for the small server it runs on, and you can use any screen you already own.

### Do I need Immich to use ImmichFrame?

Yes. ImmichFrame shows photos from an Immich server and has no photo library of its own. Immich is also in the Cloudgate catalogue, so you can set up both on Cloudgate.

### Which screens can show ImmichFrame?

ImmichFrame runs on any device with a web browser, such as a tablet, a computer, a Raspberry Pi or a smart TV. There are also apps for Apple TV, iPhone, iPad and Android, an Android TV screensaver, and a way to run it on Frameo photo frames.

### How do I connect ImmichFrame to my Immich photos?

In Immich, create an API key under Account settings > API keys, then enter it with your Immich web address when Cloudgate sets up ImmichFrame. To change them later, use ImmichFrame's admin page, which has a Test connection button.

### How do I sign in to ImmichFrame the first time?

Open your ImmichFrame address followed by /admin and sign in with the admin password Cloudgate generated, which is shown on the app's variables page. Your Immich account is already connected, so you go straight to choosing albums, people and the clock or weather.

### Can anyone with the ImmichFrame address see my photos?

No. Cloudgate switches on ImmichFrame's access secret, so a screen shows photos only after you enter it once. Open the frame's address with ?authsecret= and the secret on the end, or type it into the box the page shows, and the screen remembers it.

### Does ImmichFrame keep copies of my photos?

No. ImmichFrame reads photos from your Immich server as it shows them and can keep a short-term cache, while videos are always streamed from Immich.

### Can ImmichFrame show the weather and my calendar?

Yes. In ImmichFrame, add a free OpenWeatherMap key and your location for the weather, and calendar links in .ics form, such as a Google Calendar private address, for upcoming events.

### Do I need technical skills to run ImmichFrame?

No. Click Deploy, create your Cloudgate account and choose a server, and Cloudgate sets up ImmichFrame and gives it a web address. You use it in your browser like any other online tool.

### Do I need my own server for ImmichFrame?

No. When you deploy ImmichFrame, hosted Cloudgate can provide a server. If you already rent one, you can connect it instead.

### Can I move my data from Nixplay to ImmichFrame?

Most people export from Nixplay and import into ImmichFrame. The official guides at immichframe.dev walk through it.
