Install Tab
Choose how the report button reaches your site or app, and control who can use it.
The Install tab is where you put the report button on your site or app. Pick a channel, copy the snippet or key, and the status in the sidebar turns Live on your-site.com the moment the widget loads.
Channels
Pick one. The choice is saved on the project.
| Channel | What you set up here |
|---|---|
| Script | The embed snippet, the API key, and access options |
| WordPress | A link to the plugin, the API key, and optional developer context (site URL and secret) |
| React Native | The install commands, a .env line with your API key, and the provider that reads process.env.EXPO_PUBLIC_SNAG_RELAY_API_KEY |
| Chrome extension | Sites to show it on (one host per line, *.example.com for subdomains) and how each person signs in |
Choosing Chrome extension turns on extension injection and turns off the embed for the project. Choosing another channel turns extension injection off.
Details per channel: Script tag, WordPress, React Native, Chrome extension.
Project API key
The key identifies this project to the script, the plugin, and the SDK. It's shown in the sidebar of the Install tab with a copy button. Treat it like a public identifier, not a secret: it only allows submitting reports to this project, within your plan's rate limits.
The Chrome extension doesn't use this key. Owners Sign in as owner, and invited people Authenticate with email and a 6-digit code.
Access
(Script and WordPress channels.)
Invited reporters only
When on, the widget stays hidden until someone unlocks it from their invite email.
- Turn on Invited reporters only and enter Your site (for example
example.com). Unlock applies to the whole host. - An invited person opens Your access and clicks Unlock on this project.
- They're sent back to the site and the widget unlocks in that browser.
This is separate from Chrome extension sign-in.
Site behind a password
If the site is behind HTTP Basic Auth (common on staging), turn on Site behind a password and enter the username and password. SnagRelay's screenshot service uses them to load the page.
Status
The status line polls by itself, so you don't need to refresh. For a script or WordPress install it reads Waiting for your site… until the widget phones home, then Live on {host}. If it never turns live, see Widget not appearing.