Documentation How-to guides Installing the agent
HOW-TO GUIDES

Installing the agent

The Overseer agent is the small program that connects a Windows computer to Overseer. This page explains the four ways to install it and how to choose between them.

What the agent is and why you install it

Overseer is a desired-state engine. You declare what should be true on each computer, and Overseer detects where a computer differs, acts to close the gap and verifies the result. None of that can happen until the computer can talk to Overseer. The Overseer agent is that link.

The agent is lightweight and installs on Windows computers only. It runs alongside whatever remote management tool you already have, so nothing needs to be removed first. Check the supported operating systems before you begin.

Choosing an install method

Overseer offers four ways to install the agent. Choose by the state the computer is in and by how you can reach it.

Method Best for
Provisioning package A brand new computer, or one that has been wiped and reloaded
PowerShell command A computer already in use that you can reach remotely
Executable file A computer you cannot reach remotely
Windows Sandbox Testing on your own computer

Provisioning package

A provisioning package is a file that Windows reads during its first-run setup. You download the file, copy it to a USB flash drive as an ordinary file, plug the drive into the computer and switch the computer on. Windows finds the package and applies it. The agent is installed without anyone working through the setup screens by hand.

  • Shipping direct. A new computer can go straight to the client's office and be set up remotely.
  • Rebuilding. When you reload Windows on a computer, copy the package to the root of the Windows install drive. Leave the drive in until both the Windows install and the provisioning have finished.

PowerShell command

Overseer gives you a command to run on the computer. Use it when Windows is already set up and you have a remote way to run PowerShell, such as your remote management tool. The same command can be sent to many computers at once, which makes this the usual choice when you take on a new client.

Executable file

The EXE installer suits a computer you have no remote access to. You can run it yourself at the keyboard, or send it to the person using the computer to run.

Windows Sandbox

This method starts a disposable copy of Windows with the agent already in it. Use it to try out a deployment, or to investigate a failing install, without cluttering your own computer.

Automatic onboarding

Onboarding is a computer's first setup in Overseer: the computer is assigned to its client and gets its first maintenance session. A maintenance session is one complete ordered pass over one computer.

When you install the agent you can turn on automatic onboarding. With it on, the computer starts onboarding as soon as the agent connects. With it off, the computer waits in Overseer until you assign it. You make this choice at install time only.

Not in the sandbox: Do not use Windows Sandbox to test automatic onboarding. Windows discards a sandbox when it restarts, and onboarding usually needs a restart.

Installing the agent

  1. 1Press Install agent.
  2. 2Choose the tenant. A tenant is the record Overseer keeps for one of your clients.
  3. 3Choose the install method.
  4. 4Decide whether automatic onboarding is on or off.
  5. 5Download the file, or copy the command, that Overseer produces.
  6. 6Run it on the computer in the way described for that method above.
  7. 7Confirm that the computer appears in Overseer.

If the install does not complete

  • Check the operating system. The agent installs only on supported versions of Windows.
  • Check the connection. The computer needs a stable internet connection to reach Overseer.
  • Check your security software. Security software can block a new agent. Add the exclusions Overseer needs, then try again.

The troubleshooting guide covers less common causes.

Next steps

Onboarding a computerTake a new Windows computer from the box to ready for its user. Supported operating systemsThe Windows versions the Overseer agent runs on. Running alongside your RMMOverseer has its own agent and works beside the tool you already have.
Was this article helpful?
← Script editor Onboarding a computer →

In development. Launch inquiries welcome.

This documentation describes Overseer as it is being built. If you would like to hear when it launches, get in touch.

Ask about launch