Crowdio Docs
Documentation

Crowdio User Guide

Start here when you want the fastest path from download to first healthy node. The guide focuses on the public packages Crowdio ships today: installable macOS and Windows tray apps that come online after Google sign-in, and the more manual Linux headless client.

Fastest install path The public desktop tray app is the simple path: install it, open the tray icon, and sign in with Google before routing traffic.
Most useful page The client installation guide covers setup, auth requirements, config paths, health checks, and common failures.
Docs promise These pages stay aligned with the current download surface and runtime behavior instead of aspirational packaging.

Start here

Choose your install path

Path Best for What to expect
macOS tray app Desktop operators who want the simplest install path. Install the app, click the tray icon, and sign in with Google. Login is required before routing local traffic through Crowdio.
Windows tray app Desktop operators who want a setup installer and system tray controls. Run the setup .exe, launch Crowdio, then sign in from the tray icon before enabling Route My Traffic via Crowdio.
Headless Linux Servers, VMs, and unattended nodes. You manage the binary, config file, and service lifecycle yourself. Use an explicit --config path.
Website packages Public installs from Download. The docs assume the public DMG, Windows installer, and Linux tarball packaging, not an internal engineering build layout.

Before you install

  • For the public macOS and Windows tray apps, you usually do not need to edit client.yaml before first launch.
  • Keep the generated client.yaml with the package unless you deliberately manage config elsewhere.
  • Do not hand-edit client.device_token or client.api_key values that came from Crowdio provisioning.
  • For headless Linux, assume the node must already be provisioned before the process starts.
  • For the tray app, expect first-run provisioning and traffic routing to depend on Google sign-in and a reachable API endpoint.
Important

Headless Linux is stricter than the tray app. A missing client.device_token causes the CLI to exit immediately, and a missing headless auth credential prevents the node from completing the WebSocket login path.