You are reading the documentation of Guestroll v0.1.0. The latest version is v0.5.0. Latest docs · What changed · Changelog
Skip to content

Admin guide ​

Sign in at /admin with the admin password. The admin works on a phone, but it's most comfortable on a laptop.

Dashboard ​

Totals across every event: photos, guests who sent at least one photo, page views, downloads, storage used and photos waiting for approval. Below: uploads per day over the last 30 days, the five most active photographers, and the latest events.

Events ​

New event asks for a name and nothing else; every other setting has a default you can change later. Each event has four tabs.

Photos ​

The contact sheet of everything guests sent, newest first.

  • Filter by All, Pending, Visible or Hidden.
  • Tap photos to select them, then Approve, Hide or Delete from the bar at the bottom. Hidden photos disappear for the guest who took them too, and leave the live wall; deleted photos are removed from disk.
  • Download ZIP gets every visible photo at full resolution, named 0001-camille-1a2b3c4d.jpg so they sort in the order they were taken. The archive streams, so even a multi-gigabyte album starts downloading immediately.

Stats ​

Uploads per hour over the event (a party lasts a night, so hours are the useful unit), page views, downloads, wrong access codes and top photographers.

QR & sharing ​

  • Guest link: the address behind the QR code, to paste in a message.
  • QR code design: presets, colors, dot and corner shapes, margin, a logo in the middle and a caption. The preview is the exact file you download, as PNG (512 to 4096 px) or SVG. Remember to Save before downloading.
  • Printable poster: an A4 card with the event name, date and QR code.
  • Open live wall: a full-screen slideshow for a projector or a TV. New photos jump the queue and appear within five seconds; in between, it cycles through the latest ones. Only visible photos are shown, so with Approve each photo first nothing reaches the screen until you approve it.
  • Generate a new link: changes the address. The old QR code stops working at once, for everyone. Use it if the code leaked.

Settings ​

SectionSettingWhat it does
EventName, welcome message, date, accent colorWhat guests see at the top of their page. The color tints the camera and the buttons; the text on it adjusts automatically.
AccessAccess codeOptional, 6+ characters. Guests type it once. Leave empty to let the QR code alone grant access.
UploadsAccept uploadsTurn uploads off at any time; guests keep their own photos.
Close uploads automatically atFor example the morning after.
Capture modeCamera only (the default), library only, or both.
Photos per guest0 for no limit. Guests see a counter of photos left.
ModerationPublish immediately and hide later, or approve each photo first.
GuestsAlbum languageAutomatic (each guest's phone) or one fixed language. Guests can still switch.
Ask guests for their nameShown next to their photos in the admin and on the live wall.

Danger zone: deleting an event removes every photo from disk. Type the event name to confirm.

Settings ​

  • Language and theme for your own browser.
  • Admin password: changing it signs out every other session. Not available when ADMIN_PASSWORD is set: change the variable and restart instead.

Released under the MIT License.