Orion server installation
Pre-requisites
- Ensure your hardware meets all of the System requirements.
- Ensure that the server's OS is prepared correctly. If necessary, please refer to our guide for installing Ubuntu 24.04 LTS Minimized.
- Please note that this server will contain sensitive biometric information. As such, it must be kept in a physically secure location and installed on encrypted storage within the server.
Required information
- The following information on-hand:
- Ubuntu Server IP - This is the network location of the machine being configured as an Orion Server.
- Space Server IP - This can be found in the Space Configurator.
- Space Server Port - This can be found in the Space Configurator.
- SHIP API Key - This can be found in Salto Space's General Options.
- Space Server Name - This can be found in "view your PC's name" section of Windows.
- Access to the shell on your prepared Ubuntu server, with
sudo
privileges. This can be via SSH access or natively. If you are controlling the server via SSH, the install script automatically keeps the SSH port open for server management. - Access to Powershell (not cmd) on your Space server, running as administrator.
Step-by-step
The admin operator will have received a welcome email when the Salto partner provided them access to their site within the Orion Console. The email will contain a link to the correct console for their region.
Available Regions are: EU, UAE
- Log in to the Orion Console for the appropriate region.
- Select the site from the drop-down in the left-hand pane.
- Click the + Add Server tile to be taken to the installation wizard. Through this wizard, you can provide some information for the Console to generate an all-in-one installation script for your prepared Ubuntu server.
- Double-check the site configuration.
- In the respective fields of the ACS configuration, select Space from the System drop-down, enter the Space Server IP, Space Server Port, SHIP API Key and, if Space is not already using HTTPS, enter the hostname of the machine running Space in Space Server Name.
Support for other ACSs are in the works. For now, only Space is available.
- In the Orion Server Information screen, enter an appropriate Server Name and the Ubuntu Server IP. Check both boxes and Continue.
- Copy the command provided into the console of your server, and follow the instructions which appear in the console.
After some system checks from the script, type "yes" to confirm and then "yes" or "no" to leaving an SSH port open for management.
Upon completion the server reboots; when it restarts, it is then operational.
- Installation can take 10 minutes or longer depending on your internet connection speed.
- This screen automatically moves on when The Orion Console first receives contact from your Ubuntu Server.
In the event of a problem that means you have to exit the wizard after creating your server, you can find the install commands in the Configure tab of the server page. When generating a build command, there are 3 options: Full Build, Resync, and Build and Restore from Backup. For the first installation of a server, use Full Build. Further details can be found in the monitoring guide.
- Copy the Space server command onto Powershell on your Space server. This will install the Salto root CA public certificate and create an entry in the server hosts file for orion-server. This will be required so that the SPACE server is able to verify the TLS certificate provided by the Orion Server. It will take less than a minute.
Some AnitVirus software my trigger the script to report an error, however, it will have created the entry in the hosts file and inserted the Salto Root Certificate.
- Within the Space General Options, navigate to the Face recognition tab and input the Orion API Key provided in the screen below.
Test Connection cannot succeed until the server has finished installing.
- The final screen is informational and updates in real time.
In order from left to right there are 3 red/green icons indicating connectivity:
- Orion Server
- Orion's connection to the ACS
- Orion's connection to the OES When all 3 have turned green, server installation is complete.
- Click Close to exit the wizard. You are then returned to the site screen, where you can now see the server status area and a View -> button to manage the server from now on.
- The final screen is informational and updates in real time.
In order from left to right there are 3 red/green icons indicating connectivity: