Setting up an agent

Downloading an agent
Launching the agent from a command prompt
Running the agent using a proxy server
Assigning a profile to an agent
Starting ingestion

Downloading an agent

See Download and register agent in "Getting Started."

Launching the agent from a command prompt

Open an elevated/admin command prompt on Windows or use sudo on Mac or Linux.
Change to the directory where the agent jar file is located; for example, on Windows:

cd LOCATION_OF_AGENT
Run the following command to register the agent:

java -Xms512M -Xmx1G -jar agent.jar key:API_KEY

Once the agent is registered, you can assign a profile to the agent.

Note
If you have set a default profile, your agent will automatically start ingesting using the settings from that profile right after you register the agent with the configuration dashboard.

Running the agent using a proxy server

Since the agent bypasses proxy server settings configured on your machine, use the following command line syntax to run the agent using a proxy server:

java -Xms512M -Xmx1G -Dhttp.proxyHost=HOSTNAME -Dhttp.proxyPort=PORT -Dhttps.proxyHost=HOSTNAME -Dhttps.proxyPort=PORT -Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD -jar agent.jar key:API_KEY

Assigning a profile to an agent

You can do either of the following:

On the configuration dashboard, next to the agent name, select the profile name from the Content Profile list and click Save.
On the dashboard, click an agent name to display the Manage Ingest Agent page, select a content profile from the Content Profile list and click Save Agent.

Once a profile is assigned to the agent, you can start ingesting content.

Note
If you save your agent with the blank row selected from the Content Profile list, the agent is automatically assigned a default profile.

You can set a default profile for all new agents. For more information, see Setting a default profile.

Starting ingestion

Click Start Ingestion on the Manage Ingest Agent page.

Note
If you have set a default profile, the agent starts ingesting content automatically right away after you register it with the configuration dashboard.