Installing OnVeris
OnVeris is installed using the OnVeris installer, available from the downloads page on our website. The installer sets up the Gateway and the Node, and works on Windows, Linux and macOS. You can install both components on one machine, or each on its own machine.
The same installer is used afterwards to update OnVeris, to start and stop it, to change access keys and to collect logs. See Managing OnVeris.
Info
The OnVeris Chat app for people's own computers and phones is installed separately. See Getting the App.
Note
Linux servers without a desktop: The installer also runs from the command line, with no window. See Headless Installation.
Download The Installer
Download the OnVeris installer from onveris.com/download. The correct installer for your platform and architecture will be indicated on the page.
Launch The Installer
Run the downloaded installer file. The installer needs administrator rights:
- On Windows, it will ask for permission when it opens.
- On Linux, it will ask for your password when it opens.
- On macOS, it will ask for your password when you click Install, and again for each change you make later.
The installer window will open.
Click Install.
Select What To Install
Choose which components to install on this machine.
| Option | What it installs |
|---|---|
| Gateway and Node | Both components on this machine |
| Gateway | The Gateway only — inference will run on a separate Node machine |
| Node | A Node only — to be connected to a Gateway running elsewhere on the network |
For a single-machine setup, choose Gateway and Node.
Allow OnVeris through the firewall: When this is ticked, the installer will let other machines on your network reach what it installs. The line beneath the box says what it will change on this machine. It is ticked by default. See Firewall below.
Install from pre-release CDN: Check this box only if you are directed to do so by Parker Software support. It installs the latest pre-release build rather than the current stable release.
If a port that OnVeris needs is already in use by another program, a warning will be shown above these options, naming the program where it can. You can still install, but the component will not start until the port is free. See Network for the ports.
Once you have made your selection, click Install.
Installation Progress
The installer will show each step as it happens.
When you are prompted to confirm a version — for example, Install Node 2.2.17? — click Yes to proceed. On macOS this prompt is not shown: clicking Install was the decision.
For each selected component, the installer will:
- Find the latest available version.
- Download the package, and check that it arrived complete.
- Unpack the files.
- Register the background service.
It will then start each service, and check that it is still running a few seconds later. If a component will not start — for example, because another program is using its port — the step will fail and say why, and where to look for the details.
Finally, if Allow OnVeris through the firewall was ticked, it will open the firewall for each component. A firewall that cannot be opened does not fail the install: the step will say what to do instead.
When every step has finished, click Continue.
Note
If an install fails while unpacking, the installer will remove the files it had unpacked, so you can run it again.
The Finish Screen
The finish screen shows what is now running on this machine.
Each component has a card with:
| Item | What it shows |
|---|---|
| Status | Running, and the version installed |
| Address | Where to reach it from another machine. The Gateway's address has Open and Copy; the Node's has Copy |
| ACCESS KEY | The component's access key, hidden until you click Show. Click Copy to copy it |
| FIREWALL | Whether other machines can reach it, and anything you need to do by hand |
Click Done to return to the first screen, or Manage to make changes. See Managing OnVeris.
After Installing The Gateway
Open the Gateway's address in a web browser, either with the Open button or from another machine, and you will be taken through the first-time setup. See First-Time Setup.
The Gateway's address includes its port, unless the Gateway is using port 443. The Gateway uses 443 when it can, and port 8025 when another program already has 443.
Note
Your browser may warn that the connection is not private. This is expected on a new installation: the Gateway starts with its own self-signed certificate. Continue to the site, and set up a trusted certificate afterwards — see Certificates and Security.
A Node installed on the same machine will connect to the Gateway by itself. Nodes on other machines need the Gateway's access key — see Installing A Node On Another Machine.
After Installing A Node On Its Own
A Node only accepts a Gateway that uses the same access key. When you install a Node on its own, the finish screen will ask you to set the key before you can continue.
- Copy the Gateway's access key. See Installing A Node On Another Machine.
- Paste it into the box under Set this node's access key.
- Click Apply. The Node will restart to use the key.
If you are setting up the Node before the Gateway, click Keep the node's own key instead. The Node's key will be shown on its card. Copy it, and set it on the Gateway once the Gateway is installed. See Access Keys.
Done and Manage will be available once the key is set or kept.
Installing A Node On Another Machine
A Node on another machine needs two things before a Gateway can use it: the Gateway's access key, and a firewall that lets the Gateway reach it.
- On the Gateway machine, open the installer and click Manage. On the Gateway's card, under ACCESS KEY, click Copy.
- On the Node machine, run the installer and choose Node. Leave Allow OnVeris through the firewall ticked.
- When the install finishes, paste the Gateway's key under Set this node's access key, and click Apply.
- In the Gateway, add the Node. See Managing Nodes.
Tip
A Gateway and a Node installed on the same machine use the same key automatically, so a Node on the Gateway's own machine needs none of these steps.
Firewall
When Allow OnVeris through the firewall is ticked, the installer will first check whether other machines can already reach each component. It changes only what is missing, so a machine whose firewall already allows OnVeris is left as it is.
| Platform | What the installer does |
|---|---|
| Windows | Adds a Windows Firewall rule for each program, OnVerisGateway and OnVerisNode, in a group called OnVeris. The rules apply on Domain and Private networks. Because each rule is for the program, it covers whichever port the Gateway uses, and Node discovery |
| Linux | If ufw or firewalld is active, opens the component's port, and UDP 5353 for Node discovery. Any other firewall is left alone, and the installer will tell you which ports to open |
| macOS | If the macOS firewall is on, allows OnVerisGateway and OnVerisNode to receive incoming connections. If Block all incoming connections is turned on, only you can change it — the installer will tell you how |
Note
On Windows, the rules do not apply on networks Windows treats as Public. If this machine is connected to a Public network, other machines will not reach OnVeris. You can allow Public networks from Manage, or set the network to Private in Windows Settings. See Firewall.
Note
On a machine first installed as Optima, the programs are OptimaGateway and OptimaNode, and the Windows rules are in the group Optima. Updating keeps them. See Machines First Installed As Optima.
Uninstalling removes the rules the installer added, and nothing else.
Updating
To update a component:
- Run the installer and click Update.
- Click Check for updates, and choose the Gateway or the Node. The latest version will be shown.
- Click Update.
The installer will download the new version before it stops anything, so a failed download leaves the running version untouched. It will then stop the service, replace the files, and start the service again, checking that it stays running.
If the new version will not start, the installer will put the previous version back and start it again. The step will say what happened.
When the update has finished, click Continue to see the finish screen. Updating keeps your settings, users, conversations and models.
Uninstalling
To remove OnVeris from this machine:
- Run the installer and click Uninstall.
- Choose Gateway and Node, Gateway or Node.
- Click Uninstall.
The installer will stop and remove the services, remove the firewall rules it added, and delete the program files.
Your data — the Gateway's conversations, users and Knowledge Bases, and the Node's settings and downloaded models — is kept unless you tick the option to remove it. Keeping it lets you reinstall without losing anything.
Warning
Removing the data cannot be undone. A Node's data includes its downloaded models, which can be many gigabytes. Take a backup first if you might need it — see Back Up And Move OnVeris.