Skip to content

Quickstart Guide

This guide provides step-by-step instructions for setting up and configuring your ONEInsight Agent. Follow these procedures to get your agent up and running efficiently.

Installation

1. Install ONEInsight Agent

  1. Download the latest ONEInsight Agent installer from ONEInsight Portal. Note: An active account is required for access.
  2. Extract the downloaded archive to your desired installation directory
  3. Launch oneinsight-agent.exe with administrator privileges
  4. Follow the on-screen installation prompts

Important Installation Note

The agent will be installed in the selected directory. For optimal performance, avoid relocating the installation directory after setup and refrain from installing in system-protected directories such as C:/Program Files.

  1. Download the latest ONEInsight Agent package from ONEInsight Portal. Note: An active account is required for access.
  2. Extract the archive to /opt/oneinsight
  3. Execute oneinsight-agent install with root privileges
  4. Create and configure the systemd service: 
    sudo nano /etc/systemd/system/oneinsight-agent.service

    [Unit]
Description=ONEInsight Agent Service
After=network.target

[Service]
Type=simple
ExecStart=/opt/oneinsight/oneinsight-agent server
Restart=on-failure
User=root
Group=root

[Install]
WantedBy=multi-user.target

    sudo systemctl daemon-reload
sudo systemctl enable oneinsight-agent
sudo systemctl start oneinsight-agent

2. Access Web Interface

Browser compatibility

To access the ONEInsight Agent web interface, you will need a modern web browser (such as Google Chrome). Accessing the agent interface with outdated browsers like the legacy Internet Explorer on Windows is not supported and will likely result in display or compatibility issues.

If your system does not have a modern web browser available, you can configure the agent to allow remote access to the web interface from another machine with a supported browser. Instructions for securely opening a port for remote access are provided in the Web Server Configuration (Advanced) section.

  1. Launch your modern web browser and navigate to https://localhost:5002
  2. Authenticate using the default credentials:
    • Username: admin
    • Password: OneInsight123!
  3. When prompted, create a new secure password (strongly recommended)

The initial administrator password is a bootstrap credential and is independent of the configured password policy. The selected policy is enforced when the password is changed or reset.

3. Install Agent Modules

  1. Download the necessary agent module from ONEInsight Portal
  2. Access the "Agent Modules" section in the Web Interface
  3. Select "Install"
  4. Choose the downloaded agent module file
  5. Confirm installation by clicking "Install"

4. Configure Email Settings

  1. Navigate to the "Transmission" section in the Web Interface
  2. Choose "Email" as your preferred Transmission Mode
  3. Configure your SMTP server parameters
  4. Save your settings
  5. (Optional) Validate your configuration using the "Send Test Email" feature

5. System Configuration

  1. Access the "Systems" section in the Web Interface
  2. Select "Add New"
  3. Choose your desired Agent Module
  4. Configure the system connection parameters
  5. Save and validate the connection
  6. Monitor the connection test progress
  7. Confirm the connection status in the system settings

Installation Complete

Recommended Next Steps:

  • Explore the Documentation for comprehensive feature details
  • Access the Help section for troubleshooting assistance

Update

This section provides instructions for safely updating your ONEInsight Agent installation to the latest version.

1. Update ONEInsight Agent

  1. Download the latest ONEInsight Agent package from ONEInsight Portal
  2. Extract the archive to a temporary location
  3. Execute oneinsight-agent.exe with administrator privileges
  4. Follow the update wizard instructions

Post-Update Cleanup

After completing the update, remove both the executable and the "data" folder from the temporary directory to reclaim disk space.

  1. Download the latest ONEInsight Agent package from ONEInsight Portal
  2. Stop the ONEInsight agent service: 
    sudo systemctl stop oneinsight-agent
  3. Extract the new package to /opt/oneinsight, replacing the existing binary
  4. Restart the ONEInsight agent service: 
    sudo systemctl start oneinsight-agent
  5. Verify the service status: 
    sudo systemctl status oneinsight-agent

2. Verify Update Success

  1. Access the Web Interface at https://localhost:5002
  2. Log in to your account
  3. Confirm the new version number in the interface
  4. Validate that all system connections remain operational

Update Complete

Recommended Next Steps:

  • Review the Documentation for new features and improvements
  • Visit the Help section if you require assistance