01. Installation

This tutorial covers installation of the server on various operating systems.

Debian Linux

This guide will walk you through installing SpecterInsight on most Debian distributions including Kali and Ubuntu. This tutorial assumes that you have already registered an account and downloaded SpecterInsight.

Install Postgres

SpecterInsight leverages Postgres as the back end data store for all data that needs to be retrieved by server application. The easiest way to setup Postgres is to run a docker container. We’ll demonstrate setting up a container locally as an example.

docker run --name postgresql -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 -v /data:/var/lib/postgresql/data -d postgres

• postgresql is the name of the Docker Container.
• -e POSTGRES_USER is the parameter that sets a unique username to the Postgres database.
• -e POSTGRES_PASSWORD is the parameter that allows you to set the password of the Postgres database.
• -p 5432:5432 is the parameter that establishes a connection between the Host Port and Docker Container Port. In this case, both ports are given as 5432, which indicates requests sent to the Host Ports will automatically redirect to the Docker Container Port. In addition, 5432 is also the same port where PostgreSQL will be accepting requests from the client.
• -v is the parameter that synchronizes the postgres data with the local folder. This ensures that postgres data will be safely present within the Home Directory even if the Docker Container is terminated.
• -d is the parameter that runs the Docker Container in the detached mode, i.e., in the background. If you accidentally close or terminate the Command Prompt, the Docker Container will still run in the background.
• postgres is the name of the Docker image that was previously downloaded to run the Docker Container.

Configure SpecterInsight Settings

Next, you will need to tell the SpecterInsight server where it can find the postgres database and how to authenticate with it. The server cannot run without the database. These configuration options are stored in /settings/settings.json.

Set Database.Host to your IP of the host where your postgres container is running. Set the Database.Username and Database.Password based on your container setup. Once you run SpecterInsight, it will initialize the database and create all of the necessary tables.

{
	"Database": {
		"Host": "192.168.1.100",
		"Database": "specter",
		"Username": "postgres",
		"Password": "postgres"
	},
	
	"Authentication": {
		"Secret": "1e49a7aeb6624570824ef6d5cc30544e"
	},
	
	"Elastic": {
		"Uri": "http://192.168.1.100:9200",
		"ValidateServerCertificate": false,
		"Index": "specter",
		"Username": "elastic",
		"Password": "elastic",
		"MaxDepth": 6
	}
}

Note: The server cannot run without a PostgreSQL instance to connect to; however, it can run without an ELK instance. If there are ELK settings, but no actual service listening, then the server will take an additional 30 – 60 seconds to startup as it tries to connect to the ELK API. If that fails, the server will continue on and attempt to reconnect periodically.

Install Dependencies

wget https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb

sudo apt-get update
sudo apt-get install -y aspnetcore-runtime-8.0

Start the Server

To start the server, run the following commands. A default configuration file is provided that will work for most installations. On startup, SpecterInsight will setup and configure the database, create the default admin account, and start the management API on HTTPS port 1337.

cd server
dotnet ./SpecterInsight.Server.Host.dll

⚠️ Any IP address can connect to the management port (TCP 1337). We recommend not exposing this port to the open internet.

Start the Client

The SpecterInsight client GUI is also written in .NET and leverages the AvaloniaUI to provide a consistent user experience across multiple platforms. Run the following commands to start the client.

cd client
dotnet ./SpecterInsight.UI.dll

Windows

This guide will walk you through installing SpecterInsight on most Windows 10 and above systems. This tutorial assumes that you have already registered an account and downloaded SpecterInsight.

Install PostgreSQL Server for Windows

For detailed instructions on a basic installation of PostgreSQL, follow this tutorial here: https://practicalsecurityanalytics.com/how-to-install-postgresql-on-windows/

Return to this tutorial when you are finished.

Install Dependencies

Download and install the latest version of .NET for Windows from the Microsoft website: https://dotnet.microsoft.com/en-us/download/dotnet/

Start the Server

To start the server, run the following commands. A default configuration file is provided that will work for most installations. On startup, SpecterInsight will setup and configure the database, create the default admin account, and start the management API on HTTPS port 1337.

cd server
./SpecterInsight.Server.Host.exe

Start the Client

The SpecterInsight client GUI is also written in .NET and leverages the AvaloniaUI to provide a consistent user experience across multiple platforms. Run the following commands to start the client.

cd client
./SpecterInsight.UI.exe