Skip to content

Guide

The guide gives every Prism feature its own page. Once setup is done, start here: each section below sums up one feature and links to its full page.


First-time setup

Setup takes five steps:

  1. Install Prism by following the installation guide.
  2. Add your family members under Settings → Family Members → Add Member. Each one gets a name, colour, avatar, role (parent or child) and their own 4- or 6-digit PIN.
  3. Set the PINs. Each member chooses a 4- or 6-digit PIN in the setup wizard when you first install, and can change it later in Settings → Security. A fresh install opens straight into the setup wizard, since there is no default PIN to log in with. The optional demo family uses 1234 for everyone, so change those PINs before you use Prism for real.
  4. Connect integrations under Settings → Integrations. Most families connect at least Google Calendar, weather (Open-Meteo is the default and needs no setup) and OneDrive. The first-time setup walkthrough has more.
  5. Arrange the dashboard: click the grid icon to start layout edit mode and move the widgets where you want them.

After setup, install Prism as a PWA (a web app you can add to the home screen) on phones and tablets. The Mobile guide shows how.


Logging in

Tap your avatar and enter your PIN, which is 4 or 6 digits depending on how it was set. The PIN goes in as soon as you type the last digit. You can also use a keyboard (0-9, Backspace and Enter). Each time you use Prism, your sign-in is extended: parents stay signed in for about 7 days after their last use and children for 1 day, up to a hard limit of 30 days for parents and 7 days for children. There is no separate setting for shared devices.


Roles

Action Parent Child
View dashboard & pages Yes Yes
Complete chores Yes (auto-approved) Yes (pending parent approval when the chore requires approval, otherwise approved at once)
Approve chores Yes No
Edit settings Yes No
Manage family members Yes No
Redeem goals Yes No
Exit Away / Babysitter Mode Yes (parent PIN required) No
Add tasks, messages, wishes Yes Yes
Delete others' messages Yes No
Generate API tokens Yes No

There is also a third role, guest, for shared displays and kiosks. A guest can look at the dashboard and pages and cannot change anything.


Features

Calendar

The calendar pulls from Google (signed in with OAuth) and from iCal subscriptions. It has seven views (Agenda, Day, List, Schedule, 2W, Month and 3 Months). You can drag events to move them and click one in the dashboard widget to edit it. The server syncs on a schedule, and there are calendar notes, hidden hours and a view options menu. On a phone, only the Agenda view is shown.

A parent can hide an event in Prism and leave it in its calendar, using Hide in Prism in the event detail. On a recurring Google, iCal or CalDAV event, they can hide the whole series. Hidden events and series are listed under Settings → Calendars, each with Unhide. The same card lists birthdays and milestones, each with Remove, and a synced birthday you removed can be brought back from Removed birthdays.

Shopping

Keep several lists, each laid out by category, and see who added each item. You can scan barcodes with the camera or a USB scanner, sync lists both ways with Microsoft To Do, and send a list to your online Kroger cart at any Kroger banner with one click. The dashboard and screensaver widget hide checked items, and an item ticked by mistake stays for five seconds so you can untick it.

Recipes

Import recipes from a web address (any page that uses the schema.org recipe format), from Paprika, or by pasting text. Pasting works well with text read from a photo (OCR), and it keeps ingredient sections. You can upload a photo for each recipe and scale it with the ½× to 4× pills, and "Add to Shopping List" adds the ingredients at the scale you picked.

Tasks

Tasks are to-do items that you can assign to someone and give a due date, a priority and a list. They group by person and then by list, and sync both ways with Microsoft To Do or Google Tasks.

Chores

Chores are household jobs that come round again, each with a person, a frequency and points. The Chores page opens on what to do today, tomorrow and later this week, and parents set chores up behind Manage. A chore can need a parent's approval before its points count. When Require the PIN for every change is off, chores can be ticked on the wall without a PIN.

Goals & Points

Kids earn points from approved chores. Parents set goals that repeat, such as an allowance, or happen once, such as a LEGO set. Points fill the goals one after another in priority order, and a seasonal animation plays when a goal is reached.

Messages

Messages is the family message board. You can post a message, pin it, mark it important, set when it expires, edit it where it is and group the board by person.

Wishes & Gift Ideas

Each member has a wish list, and others can claim an item in secret. Gift-givers can also keep private notes of gift ideas.

Photos

Upload photos directly or sync them from OneDrive, choosing folders with a folder picker. The location stored in each photo feeds the Travel Map photo strip. The screensaver, the dashboard wallpaper and the slideshow widget all use these photos.

Travel Map

The travel map is an interactive 3D globe for places you have been, places you want to go and trips with several stops (as a route, a loop or a hub). Photos that carry a location link themselves to nearby pins.

Weekend Ideas

Weekend Ideas is a family board of local places to visit. Keep a list of ideas, mark places as visited, and add ratings, tags and favourites.

Bus Tracking

Bus Tracking predicts when the school bus will arrive by reading FirstView emails in Gmail. It adjusts how often it checks, finds routes on its own and keeps separate morning and afternoon trips for each student.

Display Modes

There are three modes that cover the dashboard. Screensaver runs when the screen is idle, Away Mode hides the family's information for privacy, and Babysitter Mode shows what a sitter needs. While Babysitter Mode is on, the sitter can leave a note for the family on the Messages board.

Themes

Choose one of seven colour palettes under Settings. The palette is set once for the whole house, and each screen keeps its own light or dark setting. Every palette is checked for readability before it ships. Adding ?theme=default to the address resets a display that has no keyboard.

Mobile & PWA

Prism installs as a PWA on iOS, Android and desktop. On a phone you get a floating add button in the corner (the FAB), a simpler one-column dashboard and the calendar as an agenda.

Integrations


Other features (covered inline below)

These smaller features have no page of their own, so they are described here.

Meals

Meals is a weekly meal planner. Plan each meal by day and type (breakfast, lunch, snack or dinner). A meal can also have a time of day, which places it on the calendar; if you leave it blank, breakfast is at 7am, lunch at 12pm, snack at 3pm and dinner at 6pm. Link a meal to a recipe from the Recipes library, and opening the meal takes you to that recipe. Mark meals as cooked to keep track. You can drag meals between days, also in the dashboard Meals widget on a touch screen, and filter the week to one or more meal types with the breakfast, lunch, dinner and snack pills. To bring in a meal plan from Tandoor or Mealie, use Add ▾ → Sync meal plan…: you review and approve the meals, and they arrive with their recipes. The week starts on the day set in Settings → General → Week Starts On.

Performance

Each screen runs at one of three levels, set in Settings → Appearance → Performance:

  • Full: every effect is on.
  • Reduced: no backdrop blur, no full-screen celebrations or particle effects, a still night sky.
  • Minimal: Reduced, plus the Photo widget shows one static image, refreshes come ~2.5× less often, and fades are near-instant.

Auto is the default. It starts at Full and times the fade each time the screen goes idle or wakes. After three choppy fades in a row it steps down one level and stays there. Picking a level by hand overrides it. A lightning-bolt badge in the dashboard header shows while a screen runs below Full. A kiosk can set the level in its address with ?perf=auto, full, reduced or minimal.


Settings reference

This is a short tour of Settings. Where a section belongs to a feature, that feature's page above covers it in full.

  • Account & Profile shows the current session and the default display user.
  • Family Members is where you add, edit and remove members and set their names, colours, avatars, roles and order. Pick a colour from the 18 presets, or tap the rainbow swatch to choose any colour with the sliders or a colour code, then tap Done. The panel shows each colour next to every other member's. A colour another member already uses, preset or custom, shows that member's initial, and two members can still share it.
  • General sets the weather location (city or postal code), the time zone and Week Starts On.
  • Integrations has one card for each provider: Google (Calendar, Tasks), Microsoft (To Do, OneDrive), Gmail (bus tracking), Apple / CalDAV and Kroger (shopping cart push), plus Photo Sources. You choose which task, shopping and wish lists sync inside the Microsoft or Google card.
  • Text Size sets how large everything reads on each dashboard.
  • Appearance holds Color Scheme (Light, Dark or System), Theme Palette, Seasonal Theme, Performance, Screensaver (start delay, a background of photos or night sky, photo rotation, the widget transition effect and its options, and drift), the timers for Auto-Hide Navigation, Away Mode and sign-out, and Orientation Override.
  • Displays lets you name a screen from the screen itself (for example "Kitchen") and see every named screen and whether it is on. A named screen keeps its screensaver, performance, keyboard and screen-shape settings under its name, so after a browser is reset it can take them back with Or this is an existing screen. Each screen can open on its own dashboard. A browser nobody has named works the same as before.
  • Photos manages sources (Local, OneDrive, Immich), with a folder picker, display filters for orientation and resolution, GPS backfill (adding locations to older photos) and the pinned wallpaper and screensaver photos.
  • Bus Tracking covers the Gmail connection, route setup, finding routes automatically and the Gmail label filter.
  • Input has switches for the on-screen keyboard and the barcode scanner. The keyboard has a household switch and a choice per device (Use household setting, Always or Never), so a tablet can use its own keyboard while a wall display keeps Prism's.
  • Babysitter Info holds emergency contacts, house info (the WiFi password is stored encrypted with AES-256-GCM), child info and house rules.
  • Features shows or hides each page in the navigation.
  • Security holds the PINs and API tokens, with a choice of Voice or Full scope for each token.
  • Backups & Data lets you create, download, restore or delete database backups. It also has destructive actions (Truncate and Seed demo data) that ask you to confirm first. On an install that started with the demo family, a Demo data card removes it.
  • Activity Log is a log of every action taken in the app, which you can filter.
  • About shows the version and links, and lets you run the setup wizard again.

Calendar management (turning synced calendars on, assigning and colouring them, iCal subscriptions and Calendar Hours) has moved out of Settings. You now find it behind the Manage button on the Calendar page.


Installing as PWA

The Mobile & PWA guide has the steps and tips for each operating system.


Keyboard shortcuts

Shortcut Where Action
0-9 PIN pad Enter digit
Backspace PIN pad Delete last digit
Enter PIN pad Submit
Escape Modals Close
Ctrl+Enter Message edit Save
Ctrl+B Calendar notes Bold
Ctrl+I Calendar notes Italic
Ctrl+U Calendar notes Underline
Ctrl+Shift+S Calendar notes Strikethrough
Ctrl+Shift+L Calendar notes Bullet list
Ctrl+Shift+M Layout editor Toggle measure mode

Troubleshooting

Each feature page has its own troubleshooting section:

These problems come up often:

Forgot PIN

A parent can set a new PIN for a child or guest without knowing the old one, in Settings → Security → Change PIN. Changing a parent's own PIN, or a co-parent's, still needs the current one. A parent who forgot theirs can be reset with scripts/reset-pin.js on the server.

Stuck in Away or Babysitter Mode

A parent PIN exits both modes. If you forgot it, reset it by hand with docker exec prism-db psql -U prism -d prism -c "UPDATE users SET pin='\$2a\$12\$...' WHERE role='parent';". The install guide has the details.

"Failed to save" / "Failed to add"

Since v1.8, these messages include the reason the server gave. If you see "rate limit exceeded", wait a minute and try again. Other failures show the cause, such as a validation error or a database constraint.

Widget not loading

Refresh the page, using Ctrl+Shift+R for a hard reload. If Prism is installed as a PWA, uninstall it and install it again.


Support