KERYXUser guide
⌘K
DownloadOpen KERYX

Getting started

  • Welcome to KERYX
  • Install and update KERYX
  • Running a service, step by step
  • Your first Sunday with KERYX

Planning on the web

  • Planning on the web
  • Planning Center

Running the service

  • Services
  • Songs
  • Scripture
  • Media
  • Presenting
  • Companion

Streaming & recording

  • Audio & camera
  • Streaming
  • Recording
  • Publishing

Reference

  • Settings reference
  • Keyboard shortcuts
  • Troubleshooting

Reference

Settings reference

Every Settings pane and field in KERYX desktop, in sidebar order, with defaults.

On this page
  • General
  • Accounts
  • Streaming
  • Audio & Camera
  • Recording
  • Publishing
  • Slides & Bibles
  • Companion

This is a complete reference of every pane in Settings, in the order they appear in the sidebar. Use it to look up what a field does and what it defaults to; for setup walkthroughs, see First Sunday.

Note: Settings save automatically as you change them (a Saved confirmation flashes at the bottom of the sidebar). There's no separate save button.

#General

#Church logo

Setting What it does Default
Church logo Shown on the projector's holding slide and on the live stream. A PNG with transparency works best. Choose…/Replace… opens the file picker; Remove clears it. No logo
Holding slide background What sits behind the logo on the projector and stream: Dark or White. Pick White if the logo itself is dark. Dark

#Other

Setting What it does Default
CCLI license number Printed on song slides Blank
Video engine Used for streaming and recording — Standard (ffmpeg) or OBS engine (beta). Changes apply once both streaming and recording are stopped. OBS engine (beta) for new installs

#Accounts

#KERYX Cloud

Sign in with your team email; KERYX sends a 6-digit code by email, and entering it connects this Mac to KERYX Cloud so services and songs planned on keryx.samuraicode.ai sync down automatically. Once connected, this section shows who you're signed in as and the sync health (last sync time, or how long the cloud has been unreachable and when it'll retry). Sign out disconnects this Mac.

A Connect with a service key disclosure holds the legacy path — a Supabase URL and key pasted directly — which overrides sign-in when set. This is an escape hatch; normal setup uses the email code.

Setting What it does Default
Supabase URL (Advanced) Overrides device sign-in with a direct project URL Blank
Supabase Key (Advanced) Paired service/anon key for the URL above Blank

#Planning Center

Planning Center comes through KERYX Cloud. There's nothing to sign in to on the Mac: once the church has connected Planning Center on the web and this Mac is signed in to KERYX Cloud, this section shows Connected through KERYX Cloud.

Setting What it does Default
Service type to import from Which Planning Center service type Import next plan uses (only shown when there's more than one) All service types
Sync songs from Planning Center Matches Planning Center songs to this library by CCLI number or title. Existing lyrics are kept; only songs with no match are created. —

Plans imported on the web show up on the Mac within a minute.

#Streaming

#Destination

Setting What it does Default
Platform Facebook Live, YouTube, or Custom RTMP Facebook Live
Server URL The RTMP(S) ingest URL for your platform Facebook's live ingest URL
Stream key Paste from your streaming platform Blank

#Quality

Setting What it does Default
Resolution 720p or 1080p 720p
Video bitrate kbps 3800
Frame rate fps 30

#Advanced

Setting What it does Default
Encoder Software (x264) or Apple hardware Software (x264)
Keyframe interval Seconds between keyframes 2
Audio bitrate kbps 160
Audio sample rate 44.1 kHz or 48 kHz 48 kHz
Audio delay ms, to line audio up with video 0

#Starting soon

Setting What it does Default
Deck opacity How strongly the announcements deck shows over the camera while Starting soon is the stream layout: 50%, 70%, 85%, or 100% 85%

See Streaming for how to go live.

#Audio & Camera

#Audio input

Setting What it does Default
Device Which audio interface KERYX captures from. Shows "No devices found" (with a note to plug in the mixer and refresh) if none are detected. None selected
Channels Which stereo pair carries the service mix — a StudioLive's main mix is 1–2 Auto (stereo devices)
Gain dB boost applied before encoding. A StudioLive's USB feed runs about 20 dB low; 16 is a good start. 0

#Camera

Setting What it does Default
Device Which camera KERYX captures from Cam Link 4K
Resolution 720p or 1080p 720p
Frame rate fps 30

See Audio & Camera for wiring and level-setting guidance.

#Recording

Setting What it does Default
Save to Folder where recordings are written; Choose folder opens a picker Blank (falls back to ~/Movies)
Resolution 720p, 1080p, or 4K. 4K needs the OBS engine and a 4K camera signal, and runs about 13 GB/hour; otherwise the live stream keeps its own resolution. 1080p
Bitrate kbps 8000

#Advanced

Setting What it does Default
Encoder Software (x264) or Apple hardware Apple hardware

See Recording.

#Publishing

#Google account (YouTube & Slides)

One Google sign-in does two jobs: it uploads sermons to that account's YouTube channel, and it reads the announcements deck from that account's Drive. That means the deck can stay private, as long as it's shared with this account.

Setting What it does Default
Status Shows Connected as <email> — <channel>; Connect/Reconnect/Disconnect. If it adds · Reconnect to allow Slides, the connection predates Slides support: click Reconnect and sign in again. Not set up
Visibility Unlisted, Public, or Private for new uploads Unlisted
Playlist Optional playlist ID new uploads are added to Blank
OAuth client ID From a Google OAuth client created as a "Desktop app", with the YouTube Data API and Google Drive API enabled Blank
OAuth client secret Paired with the client ID above Blank

#Podcast

Setting What it does Default
Storage Read-only: shows whether Cloudflare R2 keys are set on this Mac or coming from KERYX Cloud Keys come from KERYX Cloud
Trim lead-in Seconds before the Sermon item that the trimmer pre-selects 3

#Podcast storage keys (Advanced)

Setting What it does Default
Account ID Cloudflare R2 account ID Church's shared R2 account
Bucket R2 bucket name Church's shared bucket
Public URL Public base URL for uploaded audio Church's shared public URL
Access key ID Overrides the key pair pulled from KERYX Cloud Blank
Secret access key Overrides the key pair pulled from KERYX Cloud Blank

Leave the key fields blank to use the pair saved in the web app's Podcast settings. See Publishing for the full upload pipeline and job states.

#Slides & Bibles

#Lyrics

Setting What it does Default
Lines per slide Longer sections split across slides 6

#Announcements

Setting What it does Default
Google Slides link The weekly announcements deck. KERYX pulls it at launch and every 10 minutes into one Announcements media item. Blank
Seconds per slide How long each announcement shows before the deck advances on its own 30
Pin to every service Opening a service adds the Announcements deck at the top if it isn't there. Move it wherever you like; it stays current. On
Refresh now Pulls the deck right now instead of waiting for the next 10-minute check —

Share the deck with the Google account connected under Publishing, or set it to "Anyone with the link can view". See Media → Announcements.

#Bibles

Setting What it does Default
Default translation Which translation the scripture picker opens on, and lookups fall back to ESV
ESV API key Free for churches at api.esv.org Blank

#Translations

Public-domain translations (shown with a Download button) download once and then work fully offline; installed ones show a checkmark. See Scripture.

#Companion

Run the service from an iPad or phone on the same Wi-Fi.

Setting What it does Default
Companion server Turns the companion web server on or off On
Status Read-only: shows the URL to open on your device when running, or "Stopped" —
PIN 4–6 digit PIN required to connect; disabled while the server is off Blank
Port Port the companion server listens on; disabled while the server is off 3777

See Companion for how to pair a device.

PreviousPublishingNextKeyboard shortcuts

On this page

  • General
  • Accounts
  • Streaming
  • Audio & Camera
  • Recording
  • Publishing
  • Slides & Bibles
  • Companion