Getting Started

Quick Start

This page will help you install Logger on your machine at the fastest and most basic level.
Logger offers a free trial for 30 days from the first installation.

Prerequisites 👇🏻

  • If you are using a Linux-based operating system, you must have Docker Engine installed. If you are using Windows or MacOS, you must have Docker Desktop installed.
  • A minimum of 12GB of memory must be allocated to Docker.
  • A minimum of 12 Core of CPU must be allocated to Docker.

Get&Start The Logger Docker Container 🏃

This document aims to install and configure the Logger software in a basic way. This process is done through a docker container. When you run the following command, a container named Logger-Setup will stand up and perform all the setup operations at the most basic level. It will then self-destruct.

$docker run --rm -v /var/run/docker.sock:/var/run/docker.sock samyoune/samet-setup

Verify ✅

Verify the Installation. Ensure that your containers are running correctly. To view the status of your containers, run the following command:

 docker ps

The output should look similar to the following:

Docker Containers

8 running
Container IDImageCommandStatusPortsNames
5bi9b46aecd5
9986f6f934bdlatest
/docker-entrypoint...Up 37 minutes
80/tcp0.0.0.0:3013->3015->3013->3015/tcp
web-app
5e4dc7219d98
ksqldb-clilatest
/bin/shUp 2 days
-
ksqldb-cli
3b354d1433d7
ksqldb-serverlatest
/usr/bin/docker/runUp 2 days
0.0.0.0:8088->8088/tcp
ksqldb-server
83dd1cca6c04
cp-kafkalatest
/etc/confluent/dock...Up 2 days
9092/tcp0.0.0.0:29092->29092/tcp
kafka-2
66e25d758e83
cp-kafkalatest
/etc/confluent/dock...Up 2 days
9092/tcp0.0.0.0:19092->19092/tcp
kafka-1
938c8a7ae901
managerapilatest
dotnet Manager.Api...Up 2 days
8080-8081/tcp
manager-api
3be6b8ec02bf
identityapilatest
dotnet Identity.Api...Up 2 days
8080-8081/tcp
identity-api
6d335ccee893
alertapilatest
dotnet Alert.Api.dllUp 2 days
8080/tcp
alert-api

That's it! You have successfully completed the Logger installation.

You can start using it now. Wait for all the pods to be in running state, and then point your browser to https://ip_address:443 to access the dashboard, replacing with the IP address of the machine where you installed product. 🏡


Send Log Data ↗️

Go to the log sending settings of your security device and enter the Ip address of the Logger. You can send logs to the Logger software via many protocols.

The log sending process may differ depending on the security device. You can find how to send logs from some security devices on our blog page. If it is not available on our blog page, you can go to the official website of the device brand and browse the support documents.
In the section below, you can access the blog posts of log submission processes of some brands;
Fortigate: blog/how-to-config-fortigate...
Sophos: blog/how-to-config-sophos...
Palo Alto: blog/how-to-config-paloalto...

Add Data Source ➕

After the installation is complete, log in to the Web UI. Then open the Datacollector page and follow the steps below.

Steps to Add Data Source ⛁

Go to Management > Source and then click Create New button.

  • Vendor: Select the device brand
  • Data Source: Select your device and then click Add Button

License Activation(Optional) ✅

  • After adding the data source, a 30-day demo license is automatically defined. If you have the license key, you can click the Activation button in the Action section and enter your license key.

Viewing Live Data 🧐

Go to Data View > Default View page.

  • Click on Data View Sources under the Data View Filters menu and select your registered source.
  • If you can see the live log stream after this process, the process has been completed successfully.

Backup & Forensic Sign 🗳️

Once the data source is added, the backup and signing service will start automatically.
The backup service uses Logger's local S3 system by default.
Check the Management > Data Management > Backup/Forensic Sign page to review.

Setup Complete!

Your system is now:

  • Receiving real-time logs from your data source,
  • Creating daily backups,
  • Signing logs at the end of each day for forensic purposes

Daily Operations:

  • Logs are automatically backed up,
  • Digital signatures are created for forensic verification,
  • No additional daily maintenance required

Add Storage Adapter(Optional) 🗄️

The backup service uses the local S3 system of the Logger software by default. If you wish, you can move the logs from the local system to your own external storage system. For this you need to add Storage Adapter To add a storage adapter, go to Management > Objects > Storage Adapter

  • And then click Create New
  • Select Storage from Storage Adapter list
  • Then enter the information requested from you.

After this process, the transfer will start automatically.