You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: align CloudNode docs with foreground-TUI + system-FFmpeg reality
Reality drift since v0.1.31 / v0.1.35: the Windows Service is no longer
the recommended runtime (the Start menu shortcut launches a foreground
TUI dashboard), and FFmpeg is not bundled (the wizard offers winget /
brew / apt install). The docs site still described the old world,
which made the install saga we just lived through harder than it
needed to be.
Fixes:
- CloudNodeSetup.jsx — primary path = Start menu shortcut /
foreground TUI; service section reframed as optional 24/7 path.
FFmpeg description now points to system package managers, not a
150 MB auto-download. Data-dir resolution clarified for Windows.
- Troubleshooting.jsx — FFmpeg recovery references winget / brew /
apt instead of the deleted ./ffmpeg/bin/ auto-download path.
- Faq.jsx — replaces "MSI vs PowerShell installer" question (the
PowerShell installer was retired in v0.1.31) with "How do I
install on Windows?" pointing at the actual current flow.
- Deployment.jsx — systemd unit now matches what install.sh
actually writes (~/.sourcebox-sentry/, sourcebox-sentry-cloudnode
run, SupplementaryGroups=video, NO_COLOR/TERM env). Adds note
that the install script offers to write the unit automatically.
- GettingStarted.jsx — drops "installer downloads FFmpeg
automatically on Windows" line.
- context.jsx — fixes the OsTabs MSI blurb claiming the service
auto-starts; updates the comment about why PowerShell installer
was retired.
Frontend build is clean (vite dist generated, 492ms).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
? 'After the MSI finishes, open PowerShell as Administrator to run setup.'
21
-
: 'Run in your terminal.'}
20
+
? 'After the MSI finishes, click the SourceBox Sentry CloudNode shortcut from the Start menu — first launch runs the setup wizard, every launch after streams cameras directly.'
21
+
: 'Run in your terminal. The script downloads the binary, runs setup, and (on Linux + systemd) optionally installs a service unit so the node restarts on boot.'}
22
22
</p>
23
23
24
24
<h3>Setup Wizard</h3>
25
25
<p>
26
-
After installation, run the wizard to enrol the node and detect cameras:
26
+
On Windows the Start menu shortcut launches the wizard automatically the first time.
27
+
On Linux/macOS the install script invokes it inline. To re-run the wizard later
Upgrades (re-running a newer MSI) preserve everything under ProgramData;
83
-
only an explicit uninstall wipes it. The CLI{' '}
84
-
<code>sourcebox-sentry-cloudnode uninstall</code> subcommand is for source-built
85
-
installs and redirects MSI users to Settings → Apps if you accidentally
86
-
run it on an MSI machine.
91
+
Upgrades (re-running a newer MSI) preserve everything under ProgramData; only an
92
+
explicit uninstall wipes it.
87
93
</p>
88
94
89
95
<p>
90
-
See the CloudNode <ahref="https://github.com/SourceBox-LLC/opensentry-cloud-node#running-as-a-windows-service"target="_blank"rel="noopener noreferrer">README</a> for the full reference.
96
+
See the CloudNode <ahref="https://github.com/SourceBox-LLC/opensentry-cloud-node#quick-start"target="_blank"rel="noopener noreferrer">README</a> for the full reference.
<li><code>$SOURCEBOX_SENTRY_DATA_DIR/node.db</code> if the env var is set (Docker)</li>
101
-
<li><code>./data/node.db</code> if it already exists (legacy / <code>cargo build</code> installs)</li>
102
-
<li><code>C:\ProgramData\SourceBoxSentry\node.db</code> on Windows MSI installs</li>
107
+
<li><code>./data/node.db</code> if it already exists — Linux/macOS only, for legacy <code>cargo build</code> installs (Windows always uses the platform default below)</li>
108
+
<li><code>C:\ProgramData\SourceBoxSentry\node.db</code> on Windows</li>
103
109
<li><code>./data/node.db</code> otherwise (fresh manual install on Linux/macOS)</li>
104
110
</ul>
105
111
<p>The API key is encrypted at rest. Key settings:</p>
Copy file name to clipboardExpand all lines: frontend/src/pages/docs/GettingStarted.jsx
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ function GettingStarted() {
70
70
<li>A USB webcam (built-in laptop cameras work too)</li>
71
71
<li>A SourceBox Sentry account (free tier covers up to 5 cameras across 2 nodes, with 30 viewer-hours/month of live playback)</li>
72
72
<li>A Linux, Windows, or macOS machine for CloudNode</li>
73
-
<li>FFmpeg installed (or Docker) — the installer downloads it automatically on Windows</li>
73
+
<li>FFmpeg installed (or Docker) — the setup wizard offers to install it via your OS package manager (<code>winget</code>on Windows, <code>brew</code> on macOS, <code>apt</code>/<code>dnf</code>/<code>pacman</code> on Linux)</li>
74
74
<li>Outbound HTTPS access from the CloudNode machine to the internet</li>
75
75
</ul>
76
76
@@ -95,7 +95,7 @@ function GettingStarted() {
95
95
<divclassName="docs-step-content">
96
96
<h4>Install CloudNode</h4>
97
97
<OsTabsid="qs"/>
98
-
<p>The installer downloads CloudNode, checks for FFmpeg, and walks you through setup.</p>
98
+
<p>The installer downloads CloudNodeand walks you through setup. If FFmpeg isn't already on the system, the wizard offers to install it via your OS package manager.</p>
Copy file name to clipboardExpand all lines: frontend/src/pages/docs/Troubleshooting.jsx
+11-6Lines changed: 11 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -24,15 +24,20 @@ sudo usermod -a -G video $USER
24
24
<p><strong>macOS:</strong> grant camera access in <strong>System Settings > Privacy &Security>Camera</strong> — you'll need to approve the terminal app running CloudNode.</p>
25
25
26
26
<h3>FFmpeg not found</h3>
27
-
<p><strong>Windows:</strong> re-run <code>sourcebox-sentry-cloudnode setup</code>. The wizard downloads a portable FFmpeg into <code>./ffmpeg/bin/</code> if it's missing.</p>
28
-
<p><strong>Linux / macOS:</strong> install via your package manager:</p>
27
+
<p>CloudNode looks for FFmpeg on PATH. Install it via your OS package manager:</p>
0 commit comments