The enrollment file is a JSON file that the agent reads at startup to enroll with the Raynet One platform. It contains the enrollment token, the server's public key, and the agent settings that define how the agent communicates after enrollment.
The enrollment file holds sensitive connection information. Treat it with the same level of care as installer files and enrollment tokens — restrict read access to the system account or the account under which the agent runs, and do not store the file in shared or publicly accessible locations.
Default file location
The agent looks for a file named enrollment.json in the agent's application data folder. The location of this folder depends on the operating system:
Operating system |
Default enrollment file path |
|---|---|
Windows |
%ProgramData%\Raynet\Raynet One\Agent\enrollment.json |
Linux |
/var/lib/raynet/raynet-one/agent/enrollment.json |
macOS |
/Library/Application Support/Raynet/Raynet One/Agent/enrollment.json |
The agent uses a single enrollment file per installation. If more than one enrollment file exists at the default location from a previous installation, the agent uses the file at the standard path. No file-selection logic is applied — the agent always reads from the fixed path shown above.
Providing the file during installation
When installing the agent using the .msi installer on Windows, you can supply the enrollment file path as an MSI property during a silent installation. The installer copies the file to the default location automatically. Refer to the Deployment topic for the relevant property name and examples.
On Linux and macOS, copy the enrollment file to the default location before or after installation, using a deployment tool or a provisioning script.
What happens when the file is not found
If the enrollment file is not present at the expected location, the agent reports an error and does not start the enrollment process. No automatic retry occurs. The error is written to the agent log, which is located in the logs/agent/ subfolder of the agent's application data folder.
To resolve the issue, place a valid enrollment file at the default path and run the bootstrap_enrollment command. See CLI reference for details.
File permissions
The enrollment file contains sensitive information including the enrollment token and the server's RSA public key. Restrict access to this file so that only the account running the agent service can read it. On Windows, the file is placed in a folder under %ProgramData%, which is accessible to administrators and the SYSTEM account by default. On Linux and macOS, set file permissions so that only root can read the file.
|
Warning: |
