Configuration
After installing the LinuxGuard agent, you need to configure it to connect to your tenant and start sending telemetry data to the LinuxGuard console.
Note: For container deployments, see the Container Installation Guide which includes container-specific enrollment instructions.
Enrollment
The agent is enrolled using the enroll command, which connects the agent to your tenant account. You'll need two pieces of information:
API Key: A secure key for authenticating the agent
Tenant ID: Your unique tenant identifier
Enrollment Command
Run the following command on your system:
sudo linuxguard-agent enroll --api_key=<API_KEY> --tid=<TENANT_ID>Replace:
<API_KEY>with your actual API key<TENANT_ID>with your tenant ID
Example
sudo linuxguard-agent enroll --api_key=ak_1234567890abcdef --tid=tenant_abc123xyzFinding Your Credentials
Tenant ID
You can find your Tenant ID in two places:
Initial Email: The Tenant ID was included in the email you received when your tenant was created
Console Settings: Navigate to the Settings page in the LinuxGuard console to view your Tenant ID
API Key
To generate an API key:
Log in to the LinuxGuard console
Navigate to the Settings page
Find the API Keys section
Click Generate New API Key
Copy the generated key (you won't be able to see it again after closing the dialog)
Security Note: Keep your API keys secure and never share them publicly. Each API key can be revoked and regenerated from the Settings page if needed.
Successful Enrollment
If the enrollment is successful, you will see a confirmation message:
Successfully enrolled to LinuxGuard Endpoint: https://api.linuxguard.io/v1/After successful enrollment, the agent will:
Start collecting telemetry data from your system
Send data to the LinuxGuard console
Appear in your console's agent list
Troubleshooting Enrollment
If you encounter any errors during enrollment:
Verify your API key and Tenant ID are correct
Check your network connectivity to
https://api.linuxguard.ioReview the agent logs (see Troubleshooting)
Next Step: Check the Troubleshooting guide if you encounter any issues, or start monitoring your systems in the LinuxGuard console!
Last updated
Was this helpful?