- Docs
- On-Premise
- On-Premise Agent
- Allowing the Agent to Follow Links
Allowing the Agent to Follow Links
You can configure the Agent to follow links, allowing it to access folders that are outside of its configured root
folder.
Only use links when you need the Agent to access locations that are outside of the root
folder. If you want the Agent to access a network location directly, you can specify the path to the network location for the root
setting in the configuration file.
To enable the Follow links option, update the configuration file to include "follow_links": true
and then restart the Agent.
Within the Agent root
folder, or subfolder, you can create symlinks that point to folders outside of the root
folder, including any network attached or mounted folders. Symlinks can point to any valid and accessible NFS, CIFS, or UNC path.
Windows
To create a symlink on a Windows based system, run the following commands from a Command/DOS (CMD) terminal window:
cd C:\PATH\TO\AGENT\ROOT_FOLDER
mklink /D LINK_NAME \\SERVERNAME\C$\PATH\TO\TARGET_FOLDER
When linking to network locations, Microsoft recommends the use of UNC paths rather than using mounted drive letters.
Ensure that the Windows user account, or service account, that is running the Agent has the correct access permissions for the target of the link. When the Agent is installed as a system service, we recommend using a named Windows Active Directory user account for running the service. Set the service's Log on as option to This account and select a user account which exists on both the Agent host system and on the remote system of the link target. The selected user account will require the "Log on as a service" privilege on the Agent host system. The Agent will only be able to access the link target items that the selected user account has permissions to access.
If you use a local system user account, instead of an Active Directory account, then make sure that the local system user account exists on both the Agent host system and on the remote system of the link target.
Linux/Mac
To create a symlink on a Linux or Mac based system, run the following commands from a terminal window:
cd /path/to/agent/root_folder
ln -s /path/to/target_folder link_name
Ensure that the user account, or service account, that is running the Agent has the correct access permissions to the target of the link.