Downloadable Installers
*Please see installation instructions listed below
Endpoint Index Path
The default Heureka endpoint index path begins at the root level. In some unique cases, you may not want to index an entire endpoint from root. The index path is configurable, however this step should be completed before the installation process begins so-as to not waste time indexing unnecessary files. Skip this step if you intend to index the entire endpoint!
Windows
If you have obtained your "install.bat" file listed in step three below, please make a copy of it before editing the file.
Using a text editor, open the "install.bat" file and locate the line beginning with "-DCRAWL_ROOT=". You will be editing the information directly after the equal sign "=". In the example at the right, you can see that the start location for indexing is a folder named "Example Folder" located on the desktop of the computer. Please keep in mind that if there are any spaces in the path, it must be enclosed in quotation (") marks. DO NOT alter any other information inside the "install.bat" file. Once your path is changed, save and close your "install.bat" file.
Macintosh
If you have obtained your "agent.config" file listed in the Macintosh Instructions > step five below, please make a copy of it before editing the file.
Using a text editor, open the "agent.confi" file and locate the line beginning with "agent.indexer.crawlPaths=". You will be editing the information directly after the equal sign "=". In the example at the right, you can see that the start location for indexing is a folder named "Index Info" located on the desktop of the computer. DO NOT alter any other information inside the "install.bat" file. Once your path is changed, save and close your "agent.config" file. Your Mac will probably change the file to a .rtf file once you save it. You should rename the file back to agent.config and force the system to change the extension from .rtf to .config.
Install.bat example showing custom folder path
Macintosh agent.config file showing custom folder path (second line)
Installing the endpoint service
Downloadable Installers can be accessed above.
Windows Instructions
- Create a folder on your desktop named "HeurekaAgent"
- Download the installer package (HeurekaAgentInstall.exe) from the area above and place in the folder from step 1. If unable to download directly to the folder, move the installer to the folder once it has successfully downloaded.
- Contact Heureka to obtain your install.bat file. This file contains pathing to connect to Interrogate as well as the license key required to check into Interrogate for searching.
- Once provided, move the "install.bat" file into the same folder as the downloaded executable file obtained in step 2.
- Right-click the "install.bat" file and select "Run as Administrator".
- As a reminder, this is a silent install so you will not see prompts on screen. Navigate to your Task Manager > Services. You should now see a service running called "HeurekaAgent".
- In Task Manager, select the "Processes" tab at the top and scroll until you are viewing "Background Processes". In Windows 7 you should see "HeurekaAgent.ext *32" and "HeurekaAgentHelper.exe *32" running. In Windows 8+ please look for "Java(tm) Platform SE binary (32 bit). Expand this proces and you should see "HeurekaAgent" running.
- Your system should now be indexing. Depending on the start point of your index, the initial index will take some time to complete. Once finished, you will see a "Crawled Date" in Interrogate > Configuration > Endpoints.
- Once the Crawled Date appears, you are now ready to search your endpoint!
Image showing downloaded .exe file and install.bat
Step 7 showing HeurekaAgent Service running
Step 8 showing Heureka Agent process running in Windows 10
Step 10 showing Interrogate > Configuration > Endpoint agent Crawled Date
Macintosh Instructions
- Open a terminal window on your Macintosh. This can be found in MacintoshHD > Applications > Utilities > Terminal or type "Terminal" in the search tool in the upper right corner.
- Type the following command into your terminal window: sudo mkdir -p /usr/local/opt/heureka-agent/conf You will be prompted for your password in the terminal window.
- Navigate to the new directory created in the command above. The folder can be found at /usr/local/opt/heureka-agent/conf. An easy way to navigate to the folder is to use the Mac's hourglass search tool in the upper right-hand corner. You can enter the path to navigate to the folder.
- Download the installer package (HeurekaAgent.pkg) from the area above and place in the conf folder created in step 2.
- Contact Heureka to obtain your agent.config file. This file contains pathing to connect to Interrogate as well as the license key required to check into Interrogate for searching.
- Once provided, move the "agent.config" file and "HeurekaAgent.pkg" downloaded in step 2 to the conf folder. You may be required to authenticate the move into the folder. Click "Authenticate" and then enter your password if prompted.
- Double-click the "heureka-agent.pkg" installer and follow the prompts to install. You will be required to re-enter your password.
- If successful, you should see the "Installation was completed successfully" message in the installer. Click "Close" to close the installer. You will notice that the installer created several additional files in your conf folder.
- Your system should now be indexing. Depending on the start point of your index, the initial index will take some time to complete. Once finished, you will see a "Crawled Date" in Interrogate > Configuration > Endpoints.
- Once the Crawled Date appears, you are now ready to search your endpoint!
Step 2 - Image showing terminal window with sudo command
Step 5 - Image showing conf folder with agent.config and downloaded heureka-agent.pkg
Step 8 - Image showing successful installation screen
Troubleshooting
One of the first items to troubleshoot involves the actual communication between the installed endpoint and the Interrogate Command Center interface. There are several log files and/or console windows you can use in order to verify that the proper communication is occurring between endpoint and Interrogate. See below.
Windows
Test 1: Navigate to C:\Program Files (x86)\HeurekaAgent\log. Open the newest log file with a text editor and you should see connections between your endpoint and Interrogate. (See image to the right)
Restarting the Windows endpoint service
Should it become necessary to stop and restart the PC endpoint service, open the endpoint task manager and browse to the "Services" tab. Locate the HeurekaAgent service, right-click and select "Restart Service". The endpoint service will cycle itself back to a running state.
How to force a re-index on a Windows system
Macintosh
Test 1: To determine whether or not the endpoint service is running, open a terminal window and type: sudo launchctl list | grep heureka. You will be asked to enter your password. Once entered, the following line should appear: "com.heurekasoftware.agent".
Test 2: Open a console window using the Mac search tool. Once open, locate the com.heurekasoftware.agent.log You should see information streaming into the console window showing connections back to Interrogate. (See image to the right)
Restarting the Macintosh endpoint service
Should it become necessary to stop and restart the Mac endpoint service, open a terminal window on the endpoint computer and type the following commands:
Stop Service
sudo launchctl unload /Library/LaunchDaemons/com.heurekasoftware.agent.plist
Start Service
sudo launchctl load/Library/LaunchDaemons/com.heurekasoftware.agent.plist
It may be necessary to type your password in the terminal window!\
How to force a re-index on a Macintosh system
Open a terminal window on the Mac
- Type: curl -XPUT http://localhost:30000/api/task/index <Return>
The system will now re-index from the configured start point.
Image showing successful handshake between endpoint and Interrogate
Image showing PC Task manager for endpoint service restart