Installation

This page describes the steps required to install OS-Robot on your machine.

A prerequisite for the installation is the presence of the ASP.NET 8 runtime, which can be downloaded from Microsoft at this address.

Windows installation

Extract the ZIP file into a folder, for example, “C:\Program Files\os-robot”.

Download the ZIP file containing the application binaries from this page.

Create the necessary folders to store logs and data, open the file “appSettings.json” and configure the following keys:

• AppSettings/JobEnginConfig/LogPath
• AppSettings/JobEnginConfig/DataPath
• SeriLog/WriteTo/Args/path

{
  "AppSettings": {
    "JobEngineConfig": {
      "LogPath": "C:\\Program Files\\os-robot\\logs",
      "DataPath": "C:\\Program Files\\os-robot\\data",
  ....
  ....
  "Serilog": {
    "Using": [ "Serilog.Sinks.File" ],
    "MinimumLevel": {
      "Default": "Information"
    },
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "C:\\Program Files\\os-robot\\logs\\os-robot-.log",
          ...
          ...
        }
      }
    ]
  }

Open a command prompt as an administrator and run the following command to make the OS-Robot JobEngine executable as a service:

sc create "OS-Robot JobEngine" binPath= "C:\Program Files\os-robot\bin\OSRobot.Server.exe"

Start the service:

sc start "OS-Robot JobEngine"

Linux installation

Download the ZIP file containing the application binaries from this page.

Extract the ZIP file into a folder, for example, “/opt/os-robot-1.0.0”.

Create the necessary folders to store logs and data, open the file “appSettings.json” and configure the following keys:

• AppSettings/JobEnginConfig/LogPath
• AppSettings/JobEnginConfig/DataPath
• SeriLog/WriteTo/Args/path

{
  "AppSettings": {
    "JobEngineConfig": {
      "LogPath": "/opt/os-robot/logs",
      "DataPath": "/opt/os-robot/data",
  ....
  ....
  "Serilog": {
    "Using": [ "Serilog.Sinks.File" ],
    "MinimumLevel": {
      "Default": "Information"
    },
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "/opt/os-robot/logs/os-robot-.log",
          ...
          ...
        }
      }
    ]
}

Create the file /etc/systemd/os-robot.service with the following content:

[Unit]
Description=OS-Robot JobEngine
After=network.target

[Service]
WorkingDirectory=/opt/osrobot/bin
ExecStart=/usr/bin/dotnet /opt/os-robot/bin/OSRobot.Server.dll
Restart=always
User=root
Group=root
Environment=DOTNET_ENVIRONMENT=Production

[Install]
WantedBy=multi-user.target

From the command line, execute the following commands:

# Reload systemd to recognize the new service
sudo systemctl daemon-reload

# Enable the service to start on boot
sudo systemctl enable /etc/systemd/osrobot.service

# Start the service
sudo systemctl start osrobot

Security concerns

The installation described above, for running the OS-Robot service, assumes the use of a user with elevated privileges: “LocalSystem” for Windows and “root” for Linux.

This may be acceptable for a development or testing environment but should be carefully evaluated in a production environment.

If possibile, avoid using administrative accounts in a production environment!

Final considerations

For both operating systems, Windows or Linux, you can access the OS-Robot user interface using any browser by navigating to the default address “http://localhost:5000/Public/”.

The default credentials to access the Job Editor are:

• User: admin
• Password: admin