# MediaSFU Dashboard User Guide

Canonical interactive path: https://mediasfu.com/user-guide

This plain-text guide is provided for agents, search tools, and users who need a readable map of the dashboard guide without relying on client-side tab navigation.

## Audience

Use `/user-guide` when the reader is operating MediaSFU from the dashboard and wants workflow-first guidance. The page is intentionally non-developer-first. It can mention developer handoff points, but the main presentation should stay focused on what a dashboard user can see, decide, and verify.

## Route Map

- `/user-guide#basic-concepts` - dashboard basics, room concepts, roles, permissions, and practical orientation.
- `/user-guide#lite-dashboard` - low-configuration dashboard workflow for getting started quickly.
- `/user-guide#rooms` - create, join, manage, and close rooms from the dashboard.
- `/user-guide#balance` - understand balance, credits, billing usage, discounts, and account funding.
- `/user-guide#subscription` - review subscriptions, plan status, renewals, validity, and plan changes.
- `/user-guide#domains` - register and manage domains for approved platform access.
- `/user-guide#activity` - review activity, usage, and operational signals.
- `/user-guide#tickets` - create and follow support or service tickets.
- `/user-guide#meeting-room-params` - configure reusable event settings and meeting room defaults.
- `/user-guide#sub-users` - manage sub-users, roles, sharing, and account-level permissions.
- `/user-guide#recordings` - find, review, share, or download recordings.
- `/user-guide#ai-notes` - review AI meeting summaries, action items, transcripts, and notes sharing.
- `/user-guide#recording-settings` - configure recording defaults such as quality, watermark behavior, and storage-related choices.
- `/user-guide#api-keys` - create, rotate, disable, and protect API keys from the dashboard.
- `/user-guide#settings` - manage account and platform settings.
- `/user-guide#ai-credentials` - save AI provider credentials, use clear nicknames, protect secrets, and assign credentials to AI features.
- `/user-guide#sip-configs` - connect SIP or phone providers, configure inbound or outbound call routing, and test calls before publishing numbers.
- `/user-guide#widgets` - choose call, meeting, or AI widgets, configure allowed domains, preview the visitor experience, and hand off embed snippets.
- `/user-guide#translation` - prepare live translation, choose languages and output mode, connect provider credentials, and run a room test.
- `/user-guide#disposable-keys` - create short-lived access keys, share them only with the intended recipient, and disable or rotate them when access changes.

## Core Workflows

### Event Settings

Event settings are saved preferences that MediaSFU can apply when new rooms are created. They reduce repeated setup and help teams keep room behavior consistent.

Typical dashboard flow:

1. Open the dashboard settings area for events or room defaults.
2. Choose the defaults that should apply when rooms are created.
3. Review safety and sub-user controls before saving.
4. Create a test room and confirm that the room starts with the expected behavior.

Developer handoff is usually needed only when an external system must create or update event settings automatically.

### AI Credentials

AI credentials connect MediaSFU to the AI provider account selected by the organization. Dashboard users should create clear nicknames, protect credential access, and rotate or disable credentials when provider access changes.

Before using an AI credential live, confirm that the provider account has quota, the nickname is understandable to non-technical teammates, and only trusted admins can edit or delete it.

### SIP Configs

SIP configurations connect MediaSFU to phone providers so calls can route into live rooms or approved call workflows.

Typical dashboard flow:

1. Collect provider details such as provider name, phone number, SIP endpoint, and credentials.
2. Create a configuration with a readable name tied to the number or team using it.
3. Choose whether it supports inbound, outbound, or both directions.
4. Save and run a small test call before sharing the number broadly.

### Widgets

Widgets let a website visitor start a call, join a meeting, or reach an AI agent without a full custom interface.

Typical dashboard flow:

1. Choose the widget type based on the visitor action.
2. Configure the label, color, routing target, and allowed domain.
3. Preview the widget and confirm the visitor language is clear.
4. Send the embed snippet to the person who manages the website.
5. Test the published page from a normal browser session.

### Translation

Translation settings help participants follow a room in the language that works for them. Dashboard users should decide which languages are needed, which output mode should be used, which provider credentials are attached, and whether AI Notes or notes-only behavior is part of the session.

### Disposable Keys

Disposable keys provide short-lived access for a specific room or workflow. Use them when access should be limited, temporary, and easy to revoke.

Typical dashboard flow:

1. Create the key for the intended room or workflow.
2. Share it only with the intended recipient.
3. Confirm the access window and expected use.
4. Disable or rotate it when the purpose is complete.

## Related Pages

- Developer console guide: https://mediasfu.com/documentation
- Developer docs portal: https://mediasfu.com/docs/
- Quick usage guide: https://mediasfu.com/quick-usage
- Storybook visual companion: https://mediasfu.com/storybook/
- Machine-readable route index: https://mediasfu.com/guide-index.json