First deploy

Add the frame

Click "New frame" in the backend and pick how this frame gets set up:

• Download SD card - build a preconfigured Raspberry Pi image.
• Install over SSH - deploy to a Pi the backend can already reach. Enter its IP or hostname and SSH credentials.
• Install with a script - one command to paste on the device when SSH isn't an option.
• Flash embedded device - build and flash ESP32 or Pico firmware, straight from the browser.
• Virtual frame - no hardware at all; the backend renders to an image URL.
• Import frame - restore a frame you exported earlier as JSON.
• Adopt frame - take over a Pi that is already running FrameOS on its own (booted from a generic SD image, say). Give the backend the frame's address and its admin login; it imports the frame's settings and scenes, keeps its access key so existing links work, and points the frame at this backend. Logs start flowing after the frame's next restart or deploy. ESP32 frames can't be adopted - flash those from the backend instead.

Then name the frame and select the right display driver for your panel - there are over 120 to choose from, organised by vendor. Pick "Web only" if you just want to try FrameOS without any display hardware. HDMI frames detect their display's resolution themselves.

Before a scene arrives, the frame shows the FrameOS status screen: its name, display and resolution, network address, time zone, who manages it and "Waiting for the backend to deploy a scene." Once it has scenes, that same screen lists them - handy when a panel looks blank and you want to know whether the frame is fine.

Install some scenes

Install a few scenes onto the frame, from the built-in repositories or the scene store. Good first picks:

• Gallery scenes like Made in Space or Masterpieces - curated art that needs no configuration.
• Sample scenes like Calendar, Message board, or Unsplash image - some need API keys, which you can add under the backend's Settings page.

Deploy

Press Deploy. The backend shows a deploy plan - what gets uploaded, what gets installed - and streams the progress log. The first deploy takes the longest (it installs dependencies and uploads the FrameOS binary); subsequent deploys are fast and only ship what changed. Editing a scene afterwards is quicker still - scenes are interpreted, so nothing is rebuilt, and ESP32 frames simply receive the new scene JSON over WiFi.

When it finishes, a preview image appears in the backend, followed by the same image on the frame itself.

Control the frame

Scenes expose controls - a calendar URL, a message to display, a color. Change them from the frame's dashboard in the backend, or directly on the frame itself:

• Open the Control URL (shown under the frame's settings) from any browser on your network.
• Or scan the QR code shown on the frame.

In the backend, clicking a frame in the left rail unfolds its tools right under it - Scenes, Settings, Preview, Schedule, Logs, Metrics, Assets - and each has its own URL (/frames/<id>/logs), so you can bookmark a frame's logs.

The frame serves this control page itself, on port 8787. The backend doesn't need to be running - see Controlling the frame for the full local HTTP API.

Next step

Build your own scene in the scene editor.