Getting Started with Orcus

Technical stuff you should know

Orcus is not just one application but consists of three core applications:

Administration
The administration is the application you will use most of the time. Using the administration, you can send commands to clients, view statistics, build client executables, etc.
orcusadministration_17

Server
The server is the application the administration and the client connect to. To keep it simple, it behaves like a proxy which just redirects commands from an administration to a client. You may ask yourself: Why the extra server part? It has a lot of advantages to have a platform independent server in the middle. For example, you can host the server on your Raspberry Pi or a VPS which runs 24/7 (which allows you to create scheduled events). Multiple administrations can connect to the server which can run on different platforms (like an Android app which is also available for Orcus, found on our website).
orcusserver_17

Client
The client receives commands from the server and executes them on the computer it’s running on.
orcusclient

Let’s start

To follow the steps, you need to download Orcus from our website, extract it and register it with your license key

Create a new server

After you have started Orcus.Administration.exe, a small window pops which asks you for the ip address, port and password of your Orcus server. Because we don’t have one yet, we choose the option at the top left Create new server.
orcuscreatenewserver

A window pops up which lets you configure your server to make it run. First, we are asked to add ip addresses. These are the ip addresses (and ports) the server should be available on.

In this guide, we will configure our server to run on our current PC in our local network. If you want it to be available on the internet, you will just have to port forward it. If you want it to be on a Linux OS, please follow this guide. If you want it to run on a Windows server, just choose the Extract option and execute the file on your server.

Now, we come to a very important point: Which IP-addresses should I use? First of all, add your localhost ip address (127.0.0.1). Just click on add the add button. Now, we have to find out the IPv4 address of our PC in our local network. Perhaps you are lucky and if you press on the arrow of the ip address, there is only one ip address which begins with 10.*.*.* or 172.16.*.* or 192.168.*.*. If there are multiple local ip addresses and you are unsure which is yours, you can either just add all or open cmd.exe, execute the command ipconfig and check which ip address is related to our ethernet adapter. If your ip address is selected, just click on the add button.

If your server runs on your local network, you don’t want everybody to connect to it and perform harmful actions to the clients. To prevent this, an administration connection requires a password authentication. You can change this at any time later in the server interface.

Coming to the last option, you can optionally set up a geo ip database. This database contains information about the location of ip addresses (e. g. 123.456.123.32 belongs to New York, 233.123.674.12 belongs to Paris, etc.). If you want to locate your clients, you have to make an account at IP2Location at input your login information there.

Last, you can select the type of your server: You can either choose the server with a GUI (which requires Windows as the operating system) or a console (which also runs on Linux systems). We choose the GUI server. In the end, it should look like this:
orcusconfigureserver_17

Now, we press on Build, choose a location where the server should be saved (Do not select the folder where Orcus.Administration.exe lays in, just keep the suggested /server directory) and press on Save. If that’s done, just open the executable file and the server will start.

Troubleshooting
Problem
Solution
Server crashes on start Please make sure that the server is saved in a separate folder only for the server. Recreating the server also helps sometimes.
Couldn’t start listener: The requested address is not valid in its context The ip address does not belong to your computer. Please make sure that you use an ip address from your computer and not your public ip address.
Couldn’t start listener: Only one usage of each socket address (protocol/network address/port) is normally permitted The port you want to use is already taken by another application (perhaps another instance of Orcus?). Just change the port or restart your computer. Also, make sure that your port isn’t below 1024 because these are normally taken by system applications.

Connect to your server

First of all, please check the server window for any lines which start with [WARN] or [ERROR]. Normally, you should see these lines (perhaps a few more if you’re using the geo database):

29-09-2016 20:15:03.6419 [INFO] Creating tables...
29-09-2016 20:15:04.6769 [INFO] Starting all listeners...
29-09-2016 20:15:04.6789 [INFO] Listener 127.0.0.1:10134 started
29-09-2016 20:15:04.6799 [INFO] Listener 192.168.178.114:10134 started

If that’s the case, we can connect to this server using the administration. Use 127.0.0.1 as the ip address, select the port you used and input your password.

orcusconnecttocreatedserver

After we have pressed connect, a connection will be established to our server.

When you connect to the server using 127.0.0.1, the server will detect that and connect to the administration over named pipes which is a technology to let processes communicate

Now, you can build a client file and execute it on your remote computer.