Skip to content

Commit ccafcbe

Browse files
author
Faxbot Agent
committed
docs(mkdocs/apps): add iOS and Electron usage pages; pairing + security notes
1 parent 634276f commit ccafcbe

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed

mkdocs/docs/apps/electron.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Desktop (Electron)
3+
---
4+
5+
# Desktop (Electron)
6+
7+
A native shell around the Admin Console for desktop workflows.
8+
9+
## Usage
10+
11+
1) Launch the app and point it at your Faxbot server (e.g., `https://your-domain`)
12+
2) Sign in with an Admin API key
13+
3) Use the Admin Console tabs for Setup, Settings, Jobs, Inbox, and Diagnostics
14+
15+
!!! note "Security"
16+
The renderer runs sandboxed; no Node APIs are exposed to web content. Keep your server on HTTPS and never expose Admin Terminal over public tunnels.
17+
18+
See also
19+
- [Admin Console: Settings](/admin-console/settings/)
20+
- [Admin Console: Diagnostics](/admin-console/diagnostics/)
21+

mkdocs/docs/apps/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Apps
3+
---
4+
5+
# Apps
6+
7+
Companion apps for using Faxbot beyond the browser.
8+
9+
- [iOS](/apps/ios/): Pair with your server and access Inbox on the go
10+
- [Desktop (Electron)](/apps/electron/): Native shell around the Admin Console
11+
12+
!!! note "Commercial notice"
13+
The iOS app is part of the commercial offering. These docs cover usage and pairing only.
14+

mkdocs/docs/apps/ios.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: iOS App
3+
---
4+
5+
# iOS App
6+
7+
Pair your device with Faxbot to view Inbox and receive notifications.
8+
9+
## Pairing
10+
11+
1) Ensure your server is reachable from the device (named tunnel or domain)
12+
2) Admin → Mobile Pairing → Generate code (or QR)
13+
3) In the iOS app, enter the code (or scan the QR)
14+
4) The app exchanges the code for a short‑lived token and the best base URL
15+
16+
!!! tip "Tunnels"
17+
For off‑LAN access, use a HIPAA‑capable tunnel (WireGuard/Tailscale). Avoid quick tunnels for PHI.
18+
19+
## Troubleshooting
20+
21+
- Code expired → generate a new one
22+
- Cannot connect → verify the tunnel/domain is reachable over HTTPS from your device
23+
- Inbox empty → verify inbound provider and webhooks are configured
24+
25+
See also
26+
- [Networking & Tunnels](/networking/tunnels/)
27+
- [Inbound & Webhooks](/setup/webhooks/)
28+

0 commit comments

Comments
 (0)