Help

How the three parts fit together

Which of centralreform.live, the web siddur and Overlays you actually need.

1. centralreform.live is where the service is planned — the setlist, the charts, the band.
2. The web siddur is what the congregation reads on their own phones.
3. Overlays is what the congregation sees on the screen and on the stream.

Set up a computer once

Pair Companion and connect the graphics browser, once per computer.

1. An owner or editor opens Set up this computer, names the Companion computer, and presses Pair this Companion. Enter the six digits in Companion’s Pairing code field within 10 minutes: the module stores a device credential itself and clears the code. A code is single use and expires after ten minutes.
2. Name the output computer and press Create an output connection, then Copy the graphics URL and paste it into a 1920 × 1080 browser input with transparency on. It keeps working after restarts, so nobody re-enters a key after a restart.
3. Control key is the older shared key. Where it is set it is used instead of the device credential, so a connection made before pairing existed keeps working untouched. Copy private output URL likewise still works, as the transitional path.
4. A refused pairing code changes nothing: the previous credential stays and the refusal is shown as the connection status. Ask for a fresh code and try again.
5. If the Companion button turns red, open Companion’s connection log and look for a line beginning Realtime closed (.

Before a service

Confirm the system while the graphics input is off air.

1. Open Companion and confirm the congregation’s Overlays connection says OK.
2. Open the graphics browser input and check that the status dot in the header is green.
3. Preview checks a graphic only in this browser, and the Live window shows what the output was told to show. For the real signal check, keep the graphics input off air, then use Show on one short graphic and one long graphic, followed by Animate out and Clear. Confirm the graphics input and composite monitor after each action.

During a service

Use the controls operators already know.

1. Use the congregation-labeled Companion pages or Live control to select a graphic.
2. Preview before Show whenever the service pace allows.
3. Use Animate out for a normal exit. Use Clear only when the picture must disappear immediately.
4. If Library synchronization says pending, use the last known live graphics and resolve publishing after the service.

The scan card

The card with a QR code in the corner of the output.

1. The scan card is set up for each congregation. Where it is not set up there is no card, and Live control does not show the control at all.
2. On Live control, use Show scan card to put it up and Hide scan card to take it down. Page is an optional short label — at most twelve characters — shown beside the card.
3. Clear removes the scan card along with the graphic. Animate out leaves the card alone, because it acts on the prayer layer only.
4. The card sits under the graphics, so a panel or lower third that reaches that corner covers it. It shows through wherever the graphic is transparent.
5. From Companion, the actions are Bug on, Bug off and Set page, and the Scan card preset toggles the card and lights while it is visible.

Names for this service

Put a list of names on air for one service, without touching the library.

1. An editor opens Prepared services, chooses the prepared service, and fills in Names for this service. Type one name per row. These names are not saved to the library and are removed when this service is archived.
2. Name this list (for example, Mi Shebeirach). That title is what appears on air.
3. Type a Hebrew name, an English name, or both. Either may be blank; both blank is refused.
4. Names per panel is a whole number from 4 to 12, 8 by default. It decides how many people appear on one panel.
5. Press Put these names in the library. Each panel is measured first: if one is too full the button stays disabled and the page names it, so shorten a name or lower Names per panel.
6. The panels appear in the library as the title followed by 01 of 03, 02 of 03 and so on. Show them like any other graphic, and use Next panel to walk the set.
7. Remove these names takes them out again. Archiving the service removes them in the same write, and restoring the service does not bring them back.

After a service

Leave the next operator a known state.

1. Clear the graphic and confirm the output is empty.
2. Record any unavailable, pending, or fallback result in the status dot while the context is fresh; it attaches the time, the graphic on air and the connection state.
3. Publish library edits only after reviewing their exact preview.
4. Once a month, review provider usage and the latest recovery package with an administrator.

Accounts and handoff

Give each person their own access.

1. An administrator opens System › People and creates a one-use invitation for the person’s exact email address.
2. Choose Operator for live use, Editor for library work, or Administrator only for people who manage access.
3. The recipient opens the link within 24 hours and sets a password.
4. Disable an account promptly when a person no longer needs access. Keep at least one administrator enabled.
5. Companion installations and graphics outputs hold their own credential and are listed under System › People. Revoke one there when a computer should no longer control graphics; it stops at that device’s next reconnection, not instantly. To stop a picture at once, take the browser input off program at the switcher.

Recovery commands and file retention are documented in docs/RECOVERY.md for the administrator maintaining the deployment.