Set up sign-in and email
Configure optional social sign-in and email delivery after installing RelayRTC.
On this page
The setup wizard lets you configure or skip each external provider. Email/password signup is available through the console, with email verification skipped when email delivery is not configured. You do not need to register GitHub or Google applications to start RelayRTC.
GitHub and Google are optional and independent. Configure both values for whichever provider you enable. Resend provides verification, password recovery and account/invitation emails. Email delivery is optional for local and public installations. Skipping it disables verification and email-dependent recovery and invitations. Partial provider configuration is rejected instead of displaying a broken login option.
Save the settings using configuration management. Settings live in the generated relayrtc/.env file. These provider credentials are separate from the environment-scoped RelayRTC API key created in the console.
The URLs below use the local console at http://localhost:3002. For a public installation, replace that origin with your console's HTTPS origin in both RelayRTC and the provider settings.
GitHub sign-in
- Open GitHub's OAuth app registration. Create an OAuth app for this installation.
- Set its homepage to
http://localhost:3002. - Set its authorization callback URL to
http://localhost:3002/api/auth/callback/github. - Register the app, copy its client ID and generate a client secret.
- Save
GITHUB_CLIENT_IDandGITHUB_CLIENT_SECRETin the wizard or.env.
Use the OAuth app credentials, rather than a GitHub personal access token. GitHub's OAuth app instructions explain the registration fields.
Google sign-in
- Open the Google Cloud console and select or create a project for this installation.
- Complete the OAuth consent configuration requested for that project.
- Create an OAuth client with application type Web application.
- Add
http://localhost:3002/api/auth/callback/googleas an authorized redirect URI. - Save the client ID and client secret as
GOOGLE_CLIENT_IDandGOOGLE_CLIENT_SECRETin the wizard or.env.
Google permits localhost redirect URIs for testing. The scheme, port and callback path must match exactly. See Google's web application credential setup if you need help with its console.
Resend email
You need a sender domain you control, such as mail.your-domain.com.
- Open Resend Domains and add your sending domain.
- Add the DNS records Resend provides at your domain's DNS provider. Wait until Resend marks the domain as verified. See domain verification.
- Open Resend API keys and create a key that can send email from that domain. Copy it into
RESEND_API_KEY. See API key management. - Set
RESEND_FROM_EMAILto an address on the verified domain. Keep the surrounding quotes when including a display name.
For a verified domain named mail.your-domain.com, the sender setting could be:
RESEND_FROM_EMAIL="RelayRTC <noreply@mail.your-domain.com>"Replace the example domain with your actual verified domain. Leaving noreply@example.com in the starter does not configure a working sender.
Save and continue
Configure only the integrations you want to enable. Each selected provider needs its complete pair:
GITHUB_CLIENT_ID=your-github-client-id
GITHUB_CLIENT_SECRET=your-github-client-secret
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
RESEND_API_KEY=your-resend-api-key
RESEND_FROM_EMAIL="RelayRTC <noreply@mail.your-domain.com>"This block shows names and formats, not usable credentials. Omit settings for unused OAuth providers. Save selected values in .env, then run docker compose up -d --remove-orphans from the installation folder. You can also reopen the same-version wizard and configure the integration there. Generated infrastructure secrets are retained.
The wizard sets SKIP_EMAIL_VERIFICATION=true when email is skipped and false when a sender is configured. With email configured and the setting empty, verification is enabled. When enabling email by editing .env, also set SKIP_EMAIL_VERIFICATION=false. The wizard does this automatically when you configure a sender. Without a sender, password recovery, email changes and invitations are unavailable. the API returns EMAIL_NOT_CONFIGURED rather than pretending to send mail.
Email verification depends on a working sender. After creating your RelayRTC account, check your inbox and spam folder. If no message arrives, inspect your Resend delivery logs and confirm the sender matches its verified domain.