- Minimum system requirements
- Download and install the agent software
- Install the agent
- Enter agent token
- Optional: Run the agent as a Windows service
- Set up your connection
- FAQs and troubleshooting
- Windows version: Windows 7 or later
- RAM: 2 GB (Minimum), 4 GB (Recommended)
- 2 CPU cores
- Navigate to Resources → Agents.
- Click + Create agent.
- Name your agent and add a description.
- Click Save. Your agent now appears on the list.
- From the Install column, click the Download option and choose the operating system (Windows is the only operating system (OS) available).
- After the download, install and open the agent software.
If you downloaded the agent on the target computer, open the agent’s setup file, agent-windows.exe, from your browser and install it.
Otherwise, copy the downloaded file to the server, and double-click to launch setup.
Caution: Review the requirements before starting an installation to upgrade the agent. If you’re on agent version 3.0.10 or above you do not need to update your agent manually.
The setup prompts you to choose installation options:
- Select whether to install the agent Only for me (Administrator) or for Anyone who uses this computer (all users) in the currently logged-in profile.
- Only for me – accessible to only one user
All users – any user can run the service, but only one user should run it at a time.
Important: If you select All users, administrative privileges are not automatically assigned and the auto-upgrade feature will not work. Add admin privileges manually as follows:
- Stop the service if it's running.
- Right-click Celigo Agent in your Windows Services app.
- Click Properties → Log on.
- Click This account, write in Administrator as the username, and enter the administrator password.
- Restart the agent service.
- Click Install.
- Give Windows permission to trust the downloaded executable and proceed.
- In the Completing Agent Setup window, ensure that Run agent is checked. Then, click Finish.
The Agent shortcut is added to your desktop and Windows programs, and the software opens to ask you for an integrator.io token.
An access token secures communication between the agent and integrator.io. Your agent token is automatically generated when you create the agent. To find the token:
- Return to integrator.io and navigate to Resources → Agents.
- In the list of agents, click Show token.
- Click Copy ( ) next to the unmasked access token to copy it to your clipboard.
- In the agent software, enter the access token. The agent will automatically start communicating with integrator.io.
The agent should now be online. You may have to refresh the page to validate that it’s online.
If your token is compromised, you can generate a new token:
- In integrator.io, navigate to Resources → Agents.
- Click Actions → Generate token.
This will automatically revoke the old token, so you must enter the new one.
If you’ve followed the steps up to this point, the agent is running as a standard Windows executable. You can also run it as a Windows service to take advantage of the following benefits:
- The agent will run silently and continuously after installation and each time the system starts up
- The agent will run regardless of which user account is logged on
- As a service, the agent can be managed and monitored from remote systems
To run the agent as a Windows service:
- Double-click the Agent shortcut on your desktop.
- Choose Install service.
- The agent will confirm successful installation.
- Click OK to dismiss the user interface.
- Your system must restart to run the agent as a service.
The agent will automatically launch as a Windows service once the system restarts. However, you can choose to launch it right away. To launch it immediately:
- Double-click the Agent shortcut on your desktop.
- Click Close.
- Click Stop to stop it from running in the background.
- In Windows, search for the Services application.
- From the list of services, find Celigo agent.
- Right-click the service and click Start to run it right away.
If you later decide that you prefer to run it as an executable, in the taskbar or in the background, double-click the Agent shortcut and click Uninstall service.
- Create a connection in integrator.io from Resources → Connections or by adding a new Source or Destination app in Flow Builder.
- For the Mode, choose On-premise (the default is Cloud).
- Choose your Agent from the drop-down list.
When creating an integrator.io connection that uses an on-premise agent, your settings will depend on whether the agent is installed on the same server as the application or database.
- Same server – set the Base URI to localhost or 127.0.0.1
- Different servers on the same network – Set the Base URI to the hostname or IP address of the system the application or database is running on.
You can run only one instance of an agent on a machine. However, the same agent can be used to talk to multiple databases and applications on the same network as the agent.
For example, if you’re running SQL on two virtual machines (VM1 and VM2) and you’ve installed an integrator.io agent on VM1, your agent can access every SQL database on the same machine and any applications in the same network. Say you have an HTTP application running on VM2 and you want to create a connection. You can use the existing agent for that connection since VM1 and VM2 are on the same network.
So, as long as VM1 and VM2 are on the same network, you can access any application on both machines.
Exports and imports that leverage a connection through an on-premise agent do not need any special configuration, since the agent configuration is fully contained within the connection settings. Once the connection is established, you can build flows and integrations as normal.
How many instances of an agent can I set up?
You can run only one instance of the agent on a machine. However, the same agent can be used to allow integrator.io to talk to multiple databases and applications on the same network as the agent.
Does the on-premise agent need to be installed on the same machine as the system to be integrated?
Typically, agents can be installed on any machine within the same network as the server running the system to be integrated. However, there can be exceptions such as when setting up a JDBC connection.
How can I reopen the agent window and make changes, after it’s set to run in the background?
Most agent installations choose to Run in background, in which case the program, On-Premise Agent – integrator.io, is not visible in the Windows taskbar. To restore the agent user interface and make changes or view activity logs, double-click the program’s shortcut.
How can I keep my agent from stopping unexpectedly?
To stop your agent from closing unexpectedly, use a small and dedicated Windows server, then run the agent in the background. We recommend you don't use that machine for anything else, though you technically can.
Which IP addresses does the agent use to communicate with integrator.io?
The agent uses several IP addresses to communicate with integrator.io. If you need to open up outbound traffic for an agent running in your environment:
- Whitelist the integrator.io IP addresses for the U.S. or the EU for the HTTPS protocol.
- Whitelist the agent-extension server IP addresses for the U.S. or the EU for the SSH protocol.
To view activity logs, double-click the program’s shortcut and click View logs in the desktop application, or you can browse the folder C:\users\<UserName>\AppData\Roaming\Agent.
If the integrated sandbox and production systems are on the same network, then the best approach is to use the same on-premise agent for connections to both sandbox and production systems. If you choose to use separate agents for each environment, remember that they must be installed on different machines.