Step-by-step deployment guide
We highly recommend using our LDAP gateway instead of this import agent.
1. Creating a source in Elimity Insights
Firstly create a new Active Directory source in Elimity Insights, but do not enable automatic imports. Instead, generate API credentials for this source and note down the resulting identifier and token.
2. Configuring the agent
To configure your import agent, mount a JSON configuration file at /app/config/config.json with the properties listed below. Refer to the following attachment for a starting point:
This example configuration will simply import all users, groups, computers and foreign security principals from an Active Directory server. Edit the following properties in this file to configure the import agent to your needs:
adDomain
string
Domain for NTLM authentication; omit to use simple bind
adPassword
string
Password for NTLM / simple bind authentication
adSearchRequests
list[object]
LDAP search requests that determine which entries the agent should import
adSearchRequests[].baseDn
string
DN from which the LDAP subtree search should start
adSearchRequests[].filter
string
LDAP filter to limit which entries the agent should import
adUrl
string
LDAP URL of your Active Directory server, e.g. ldap://my-host:389 or ldaps://my-secure-host:636
adUsername
string
Username for NTLM / simple bind authentication
cronPattern
string
Optional CRON pattern describing when the import agent should run (refer to https://crontab.guru for example patterns); omit if you just want to run the agent once
insightsSourceId
number
Source identifier you noted down in step 1
insightsSourceToken
string
Source token you noted down in step 1
insightsUrl
string
URL of your Elimity Insights server
Additionally, you can mount a PEM-encoded SSL certificate at /app/config/cert.pem to override the import agent's trust store. This is especially useful if you want to set up LDAPS connections to internal hosts.
3. Deploying the agent
Having configured the agent and having created a source in Elimity Insights, you can now deploy the agent to regularly import data from your Active Directory server and upload it to Elimity Insights. Since we distribute the agent as a Docker image, our recommendation for deployment is to use a CaaS solution like Google Cloud Run or Azure Container Apps. If that's not an option, you can also manually deploy the image on e.g. Windows Server. Refer to our documentation about gateways and import agents for additional details.
4. Following up on the import
The import agent outputs logs to indicate its progress, for a manual Windows Server deployment you can check these with docker-compose logs.
Last updated