@agora-build/atem 0.8.3 → 0.8.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -249,7 +249,8 @@ atem serv files ~/docs --background # Port auto-picked; reused next run
|
|
|
249
249
|
atem serv webhooks # Receive Agora webhooks locally (auto-tunneled via ngrok)
|
|
250
250
|
atem serv webhooks --no-tunnel # Local listener only — bring your own tunnel
|
|
251
251
|
atem serv webhooks --background # Run as background daemon
|
|
252
|
-
atem serv list # List running background servers (#, ID, PID, STATUS)
|
|
252
|
+
atem serv list # List running background servers (#, ID, PID, PORT, STATUS, URL)
|
|
253
|
+
atem serv info <ID|#> # One server: status, start, every URL with its access code, log
|
|
253
254
|
atem serv kill <ID|#> # Kill a server (POSTs /leave for convo)
|
|
254
255
|
atem serv killall # Kill all background servers
|
|
255
256
|
|
|
@@ -271,7 +272,7 @@ done
|
|
|
271
272
|
|
|
272
273
|
**`serv webhooks`** — local receiver for Agora webhook events (ConvoAI: `agent_joined`, `agent_left`, `agent_history`, `agent_error`, `agent_metrics`, …; RTC NCS events). Validates `Agora-Signature-V2` (HMAC-SHA256) when a `secret` is configured in `webhooks.toml`; accepts unsigned events otherwise with a warning. Live web console at `http://127.0.0.1:9090/?t=…` (the printed URL) shows incoming events; each event also prints a one-line summary to stdout. Default tunnel provider is **ngrok**; set `tunnel_provider = "cloudflared"` for zero-auth quick tunnels. Use `--no-tunnel` if you're running cloudflared / ngrok separately for stable URLs across atem restarts.
|
|
273
274
|
|
|
274
|
-
**Access code.** Every `atem serv` page and API needs the access code in the URL it prints (`https://…:8443/?t=…`), new at each start. Opening that URL sets a cookie for the server and drops the code from the address bar; without it, every path is a plain 404, so other devices on your network can't find or use the server. Background servers print it too (`atem serv files`, `rtc`, `webhooks`), and their log has it. For `serv webhooks` only the live console needs it: Agora's POSTs to `/webhook` keep the URL you registered. In the ConvoAI page's API History, credentials are masked on screen; **Copy with full credentials** copies the requests with them.
|
|
275
|
+
**Access code.** Every `atem serv` page and API needs the access code in the URL it prints (`https://…:8443/?t=…`), new at each start. Opening that URL sets a cookie for the server and drops the code from the address bar; without it, every path is a plain 404, so other devices on your network can't find or use the server. To share a page, use its **Copy link** button: it copies the page's address, on whichever host you opened it, with the code added back (on plain HTTP away from localhost, where browsers allow no clipboard, it shows the link to copy). Background servers print it too (`atem serv files`, `rtc`, `webhooks`), and their log has it. For `serv webhooks` only the live console needs it: Agora's POSTs to `/webhook` keep the URL you registered. In the ConvoAI page's API History, credentials are masked on screen; **Copy with full credentials** copies the requests with them.
|
|
275
276
|
|
|
276
277
|
**Channel placeholders** — `--channel` accepts `{appid}` (first 12 chars of the active app id) and `{ts}` (unix epoch seconds at startup). Useful in for-loops to match the auto-gen channel format.
|
|
277
278
|
|