Skip to content

Commit d65141a

Browse files
author
Faxbot Agent
committed
docs(mkdocs/admin-console): add Setup Wizard, Settings, Diagnostics, API Keys, Plugin Builder pages with Material tabs/admonitions
1 parent ccafcbe commit d65141a

File tree

5 files changed

+148
-0
lines changed

5 files changed

+148
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: API Keys
3+
---
4+
5+
# API Keys
6+
7+
Create scoped API keys for apps and integrations.
8+
9+
## Create a key
10+
11+
1) Open Admin → API Keys
12+
2) Click “Create key” and choose scopes (e.g., `fax:send`, `fax:read`)
13+
3) Copy the generated token (`fbk_live_<id>_<secret>`) — it’s shown once
14+
15+
!!! tip "Scopes"
16+
Use least‑privilege: sending apps need `fax:send`; dashboards often need `fax:read` only.
17+
18+
## Use in requests
19+
20+
```bash
21+
curl -H "X-API-Key: fbk_live_..." "$PUBLIC_API_URL/fax/{id}"
22+
```
23+
24+
## Rotate and revoke
25+
26+
- Rotate keys periodically and revoke unused ones
27+
- Jobs remain readable if the user/account retains access
28+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Diagnostics
3+
---
4+
5+
# Diagnostics
6+
7+
Run safe connectivity checks and review provider‑specific tips.
8+
9+
## Tools
10+
11+
- Health: DB/storage/backends readiness
12+
- Providers: DNS, auth reachability, webhook URL reachability
13+
- Tunnels: quick tunnel status, logs tail
14+
15+
???+ note "What’s checked"
16+
Checks derive from provider traits (e.g., `inbound_verification`, `needs_storage`). Results include remediation links.
17+
18+
## Actions
19+
20+
- Re‑probe a single provider
21+
- View recommended callback URLs
22+
- Copy troubleshooting links
23+
24+
See also
25+
- [Networking & Tunnels](/networking/tunnels/)
26+
- [Webhooks](/setup/webhooks/)
27+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Plugin Builder
3+
---
4+
5+
# Plugin Builder
6+
7+
Install, build, and upload provider plugins — including inbound providers — without leaving the Admin Console.
8+
9+
## Install
10+
11+
- Browse available plugins and click Install
12+
- Upload a signed manifest to add custom providers
13+
14+
## Configure
15+
16+
- Provider fields and help links render from the plugin manifest
17+
- Inbound plugins expose a webhook path and verification mode (HMAC/Basic) and surface a copyable URL
18+
19+
!!! tip "SignalWire inbound"
20+
Add a SignalWire inbound plugin here to enable inbound fax delivery. After install, register the shown webhook URL in SignalWire.
21+
22+
## Test
23+
24+
- Run plugin diagnostics from Admin → Diagnostics
25+
- Use “Simulate inbound” where available to verify storage and Inbox
26+
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Settings
3+
---
4+
5+
# Settings
6+
7+
Manage outbound/inbound providers, storage, and security.
8+
9+
## Providers
10+
11+
=== "Outbound"
12+
13+
Select your sending backend. Cloud providers expose credential fields and status callbacks; self‑hosted backends show AMI/T.38 guidance.
14+
15+
=== "Inbound"
16+
17+
Choose an inbound provider or install one via Plugins. The UI shows the exact webhook URL and verification method with copy‑button.
18+
19+
!!! tip "Traits‑driven UI"
20+
The Settings screen renders fields from provider traits — no backend name checks. This guarantees clean isolation and correct guidance.
21+
22+
## Storage
23+
24+
- Local or S3‑compatible storage for inbound PDFs and artifacts
25+
- Short‑TTL tokens for PDF access; scope‑guarded downloads
26+
27+
## Security
28+
29+
- API Key enforcement (`X-API-Key`)
30+
- HMAC verification for supported providers; Basic auth for others
31+
- Optional OAuth/OIDC for Admin login
32+
33+
See also
34+
- [Webhooks](/setup/webhooks/)
35+
- [Diagnostics](/admin-console/diagnostics/)
36+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Setup Wizard
3+
---
4+
5+
# Setup Wizard
6+
7+
Configure Faxbot end‑to‑end from a guided flow: outbound provider, optional inbound, storage, and security.
8+
9+
=== "Evaluate (Quick Tunnel)"
10+
11+
1) Choose a cloud provider (Phaxio, Sinch, SignalWire, Documo, HumbleFax)
12+
2) Enter credentials and click Validate
13+
3) Open Tools → Tunnels and start a quick tunnel to get a public URL
14+
4) Set `PUBLIC_API_URL` and register webhooks where supported
15+
16+
=== "Production (HIPAA)"
17+
18+
1) Execute a BAA and disable provider document retention (cloud)
19+
2) Use a named tunnel or domain (HTTPS)
20+
3) Enable inbound with the correct verification (HMAC/Basic)
21+
4) Rotate keys and restrict Admin access
22+
23+
!!! tip "Backend isolation"
24+
The wizard shows provider‑specific fields only for the selected backend. Links and help are scoped; nothing is mixed across providers.
25+
26+
Next steps
27+
28+
- [Settings](/admin-console/settings/)
29+
- [Diagnostics](/admin-console/diagnostics/)
30+
- [Plugins](/admin-console/plugin-builder/)
31+

0 commit comments

Comments
 (0)