Skip to content

Getting Started

This guide shows the recommended setup path for Swiftcam:

  1. Configure go2rtc (required)
  2. Optionally configure Frigate
  3. Optionally run Swiftcam Server
  4. Optionally proxy go2rtc and Frigate through Swiftcam Server

1) Configure go2rtc (required)

Swiftcam needs a reachable go2rtc HTTP API endpoint.

Minimal go2rtc config example

api:
  listen: ":1984"

rtsp:
  listen: ":8554"

streams:
  front_door_high: rtsp://user:pass@192.168.1.20:554/stream1
  driveway_high: rtsp://user:pass@192.168.1.21:554/stream1

Verify go2rtc

curl -sS http://GO2RTC_HOST:1984/api/streams
curl -sS "http://GO2RTC_HOST:1984/api/frame.jpeg?src=front_door_high" -o /tmp/front_door.jpg

Configure in Swiftcam

In the Swiftcam App, go to Settings, Server:

  • Set Go2rtc API URL to http://GO2RTC_HOST:1984/api (/api is required).
  • Configure Go2rtc authentication in Swiftcam if your go2rtc instance requires auth
  • Hit the connection test icon next to the Go2rtc API URL to verify that all required endpoints are reachable.

Adapt /api and Port to your setup if using a reverse proxy.

2) Configure Frigate (optional)

Frigate is optional, but required for event timeline and Frigate-based snapshots/events. The events tab will not be shown unless the Frigate API URL is configured.

Verify Frigate

curl -sS "http://FRIGATE_HOST:5000/api/stats"
curl -sS "http://FRIGATE_HOST:5000/api/events?limit=5"

Configure in Swiftcam

In the Swiftcam App, go to Settings, Server:

  • Set Frigate API URL to http://FRIGATE_HOST:5000/api (/api is required).
  • Choose Frigate auth mode (None, Basic, or Bearer) and fill credentials/token as needed
  • Hit the connection test icon next to the Frigate API URL to verify that all required endpoints are reachable.

Adapt /api and Port to your setup if using a reverse proxy.

3) Configure Swiftcam Server (optional)

Swiftcam Server is optional. Use it for low-latency snapshot streaming and/or as a single authenticated proxy endpoint for Go2rtc and Frigate.

see how to install and configure Swiftcam Server: Swiftcam Server

```

Configure in Swiftcam

In the Swiftcam App, go to Settings, Server:

  • Set Swiftcam Server API URL to http://SWIFTCAM_SERVER_HOST:8090/api
  • Configure Swiftcam auth in Swiftcam if auth_username / auth_password is enabled

4) Optional proxy: route go2rtc and Frigate via Swiftcam Server

When Swiftcam Server is configured, Swiftcam can route go2rtc and Frigate API calls through Swiftcam. - Enable Proxy go2rtc to route all go2rtc API/WebSocket requests via Swiftcam Server - Enable Proxy Frigate to route all Frigate API requests via Swiftcam Server - Hit the connection test icon next to the Swiftcam Server API URL to verify that all required endpoints are reachable.

This is useful when: - iPhone should only access one backend endpoint - You want to centralize credentials on Swiftcam - go2rtc/Frigate are not directly reachable from the phone network

Please note, the Go2RTC WebRTC Port needs to be exposed seperately.

Verify proxy endpoints

  1. Start with direct go2rtc connection in Swiftcam.
  2. Add Frigate if you want event timeline and event details.
  3. Add Swiftcam Server when you need low-latency snapshot multiplexing.
  4. Turn on Proxy go2rtc and/or Proxy Frigate once Swiftcam is stable.

Troubleshooting checklist

  • go2rtc stream names in Swiftcam camera settings must match go2rtc stream keys.
  • If WebRTC fails, verify Swiftcam can reach go2rtc WebSocket API with the built in connection tests and check that the Go2rtc webrtc Port (8555) is reachable.
  • If Frigate events do not load, verify Frigate auth mode/token in Swiftcam.
  • If proxies fail, verify Swiftcam Server go2rtc_base_url and frigate_base_url values.