Quick Start
Install, sign in, and verify an AntGain 1.1.4 node.
This guide covers AntGain 1.1.4. Choose a package available for your device on the official download page, or follow the Docker guide.
1. Choose a client
| Client | Best fit | Guide |
|---|---|---|
| Desktop | A personal computer with a tray menu | Desktop installation |
| CLI | A terminal or a headless machine | CLI installation |
| Docker | An existing container host | Docker installation |
| Android | A supported Android device | Android installation |
For fleets or network operators, start with Provider onboarding.
2. Sign in
- Desktop: open AntGain and finish the authorization page in your browser. The client saves your API key for later launches.
- CLI and Docker: obtain your API key from Account Settings and supply it using the environment variable documented in the installation guide.
- Android: enter your account API key in the app. Android uses the key you enter in the app.
Keep API keys out of screenshots, public logs, command history, and support messages.
3. Check the connection
Desktop shows its node status at the top of the tray menu. CLI users can run antgain health; Docker users can run docker exec antgain-node antgain health. Exit code 0 means connected, and 1 means unhealthy or not connected. Android displays connection state inside the app.
A process starting is not the same as the node connecting. Connecting and reconnecting can take time; a suspended or blocked state needs the explanation in Troubleshooting.
4. View account activity
Open the Dashboard to view your nodes, account usage, and earnings. The desktop tray shows connection status and node controls; earnings and bandwidth are shown in the dashboard.
An online node is ready to share bandwidth. Traffic and earnings can vary; being online does not guarantee income.
Stop, sign out, or update
- Desktop: Stop Node stops participation; Account → Logout clears the saved API key and requires browser authorization next time.
- CLI:
antgain stop,antgain logout, andantgain updateare separate actions. See CLI commands. - Docker:
docker stop antgain-nodestops participation. Change the API key in your environment file and recreate the container to change accounts. Keep its data volume. - Android: use the app's stop and logout controls. Keep the app's stored data when upgrading.
Read Safety & Privacy before sharing a connection, and Rewards & Earnings to learn where to view your account activity.