Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.

Commit 443e7f7

Browse files
authored
Release (#27)
* Changes Requirements and others * Changes Requirements Release * Add Threat Intelligence * Add Changes release * Changes * Add changes * Changes Upgrade Server
1 parent e30a271 commit 443e7f7

File tree

13 files changed

+72
-43
lines changed

13 files changed

+72
-43
lines changed

Images/Integrations/galaxysearch.png

93.5 KB
Loading

Images/galaxysearch.png

93.5 KB
Loading

Installation/InstallationGuideAzure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Master Installation Guide for Azure
3+
title: Installation Guide for Azure
44
parent: Installation
55
nav_order: 6
66
---
@@ -56,7 +56,7 @@ Before you begin the installation, make sure you have the following prerequisite
5656
2. Open an SSH client, and connect to the virtual machine using the public IP address or DNS name.
5757
3. Provide your Azure credentials and SSH into the virtual machine.
5858

59-
## Step 4: Install UTMStack Master
59+
## Step 4: Install UTMStack
6060

6161
1. Inside the SSH session, follow the official UTMStack installation guide for Ubuntu to install UTMStack Master. You can find the installation guide at [UTMStack Installation Guide](./MasterServerInstallation).
6262
2. Make sure to carefully follow the instructions provided in the guide, including the configuration settings and any additional dependencies or packages required.

Installation/MasterServerInstallation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: default
3-
title: Master Server Setup Guide
3+
title: Server Setup Guide
44
parent: Installation
55
nav_order: 3
66
---
7-
# UTMStack Master Server Setup Guide
7+
# UTMStack Server Setup Guide
88

9-
This guide will walk you through the process of setting up the UTMStack Master Server. The Master Server is the central component of UTMStack and is responsible for managing the security operations and data collection.
9+
This guide will walk you through the process of configuring the UTMStack Main Server. The Main Server is the central component of UTMStack and is responsible for managing security operations and data collection.
1010

1111
# Linux Installation Guide
1212

@@ -82,7 +82,7 @@ To learn more about the specific firewall rules you need to create for UTMStack,
8282
Go to **<a href="./SSLConfiguration">Configuring an SSL/TLS certificate</a>** section for detailed instructions.
8383

8484
## Step 7: Accessing the UTMStack Platform
85-
Once you have successfully installed the UTMStack master server, you can now access the platform and start using it for your cybersecurity needs. Follow these steps to log in to the UTMStack platform:
85+
Once you have successfully installed the server, you can now access the platform and start using it for your cybersecurity needs. Follow these steps to log in to the UTMStack platform:
8686

8787
Open your preferred web browser.
8888

Installation/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,13 @@ The UTMStack installation process consists of three main steps:
2323
If you have chosen the Federated architecture in Step 1, follow the instructions in the **<a href="./FederationServiceInstallation">Federated Server Installation Guide</a>** after ensuring your system meets the recommended specifications mentioned in the **<a href="SystemRequirements">Federated Service Requirements</a>** page.
2424
<br>
2525

26-
1. **Setting up the Master Servers**: The master server is the central component of the UTMStack architecture, responsible for managing and coordinating all other UTMStack components and services.
26+
1. **Setting up the Servers**: The server is the central component of the UTMStack architecture, responsible for managing and coordinating all other UTMStack components and services.
2727

28-
To set up the master server, you need to create a virtual machine (VM) or physical machine that will host the UTMStack software. The VM should have a requirements of **4 cores**, **8 GB of RAM** and **256 GB of disk storage** for each **50 devices**. (Assuming you will retain 30 days of live logs). Once the VM is created, it needs to be configured with the operating system **Ubuntu Server 22.04 LTS**.
28+
To set up the server, you need to create a virtual machine (VM) or physical machine that will host the UTMStack software. The VM should have a requirements of **8 cores**, **16 GB of RAM** and **256 GB of disk storage** for each **50 devices**. (Assuming you will retain 30 days of live logs). Once the VM is created, it needs to be configured with the operating system **Ubuntu Server 22.04 LTS**.
29+
30+
*** Integration Requirements *** : To ensure optimal system performance, certain additional requirements beyond the minimums must be considered. Each integration being introduced should reserve at least 1GB of space. This reservation is crucial to ensure proper data storage and efficient system operation as a whole.
31+
32+
*** Logging Volume Considerations ***: Furthermore, it's important to take into account the volume of logs generated and processed within 10-minute intervals. If this volume exceeds 1GB within any time interval, immediate communication with the support team is required. This communication is essential to ensure system stability and performance, as well as to address any potential issues related to log management.
2933

3034
<br>For detailed instructions on setting up the master servers, please refer to the **<a href="./MasterServerInstallation">Master Server Setup Guide</a>** in the UTMStack documentation.
3135
<br>
@@ -45,9 +49,6 @@ The UTMStack installation process consists of three main steps:
4549

4650
<img title="setting capture" alt="setting capture" src="./Images/Images/../../../Images/settingcapture2.png">
4751

48-
<br>For more detailed instructions on settings , please refer to the **<a href="../UTMStackComponents/Configuration/Readme">Configuration Section</a>** in the UTMStack documentation.
49-
<br>
50-
5152

5253
5. **Save and Verify**: Save the configurations and ensure that all UTMStack services are running correctly. Verify that the desired functionality is achieved and that the system is operating optimally.
5354

Installation/SystemRequirements.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 3
77

88
# UTMStack System Resources
99

10-
To guarantee a seamless installation and peak performance of UTMStack, adhere to the given system specifications for both Master and Probe/Proxy servers.
10+
To ensure a seamless installation and maximum performance of UTMStack, adhere to the system specifications for both the UTMStack server and the Probe/Proxy server.
1111

1212
Before diving in, be aware that UTMStack approaches data retention in two distinct methods:
1313

@@ -17,20 +17,24 @@ Before diving in, be aware that UTMStack approaches data retention in two distin
1717

1818
## Assumptions:
1919

20-
It's assumed that 60 data sources (devices) roughly produce 100 GB of data monthly.
20+
It's assumed that 50 data sources (devices) roughly produce 100 GB of data monthly.
2121

22-
## Master Server Specifications:
22+
## UTMStack Server Specifications:
2323

24-
The Master server undertakes the task of overseeing and orchestrating the UTMStack platform. Below is a tabulation of the recommended specifications for the **hot log storage**:
24+
The server undertakes the task of overseeing and orchestrating the UTMStack platform. Below is a tabulation of the recommended specifications for the **hot log storage**:
2525

2626
| Data Sources (Approx. Monthly Data) | Cores | RAM | Disk Space |
2727
| ----------------------------------- | ------| ------| -----------|
28-
| **50 (100 GB)** | 4 | 12 GB | 150 GB |
29-
| **120 (250 GB)** | 8 | 16 GB | 250 GB |
30-
| **240 (500 GB)** | 16 | 32 GB | 450 GB |
28+
| **50 (100 GB)** | 8 | 16 GB | 150 GB |
29+
| **120 (250 GB)** | 16 | 32 GB | 250 GB |
30+
| **240 (500 GB)** | 32 | 64 GB | 450 GB |
3131

3232
You have the flexibility to mix and match these tiers based on the number of devices you have and your preferred hot log storage duration.
3333

34+
*** Integration Requirements *** : To ensure optimal system performance, certain additional requirements beyond the minimums must be considered. Each integration being introduced should reserve at least 1GB of space. This reservation is crucial to ensure proper data storage and efficient system operation as a whole.
35+
36+
*** Logging Volume Considerations ***: Furthermore, it's important to take into account the volume of logs generated and processed within 10-minute intervals. If this volume exceeds 1GB within any time interval, immediate communication with the support team is required. This communication is essential to ensure system stability and performance, as well as to address any potential issues related to log management.
37+
3438
## Supported Operating Systems:
3539

3640
The UTMStack installation guide provides instructions specifically for Ubuntu 22.04 LTS. It is recommended to use one of these supported operating systems for compatibility and optimal performance.

Integrations/ThreatDetectionandResponse.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ Enabling an integration allows UTMStack to correlate logs coming from the corres
1616
Each specific integration has its own guide.
1717
Our team is always working on a new integration, but here is the list of what we have developed so far:
1818

19+
*** Integration Requirements *** : To ensure optimal system performance, certain additional requirements beyond the minimums must be considered. Each integration being introduced should reserve at least 1GB of space. This reservation is crucial to ensure proper data storage and efficient system operation as a whole.
20+
21+
*** Logging Volume Considerations ***: Furthermore, it's important to take into account the volume of logs generated and processed within 10-minute intervals. If this volume exceeds 1GB within any time interval, immediate communication with the support team is required. This communication is essential to ensure system stability and performance, as well as to address any potential issues related to log management.
22+
23+
1924
| No. | Name | |
2025
| :-: | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------: |
2126
| 1 | VMWare Syslog | <img title="VMWare" alt="VMWare" src="../Images/Integrations/logovmware.svg"> |

Intro.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,6 @@ auditing and reporting.
3333
- Spam, malware, botnets,service abuse IP related.
3434
- Denial ofservice and Brute force attack and scanner IPs.
3535

36-
### Vulnerability Scanner
37-
- Application vulnerability assessments.
38-
- Network devices Vulnerability Assessment.
39-
- Azure and AWS Vulnerability scans.
40-
4136
### Log Management (SIEM)
4237
- Log collection and correlation in real-time.
4338
- Log management.
@@ -51,16 +46,15 @@ auditing and reporting.
5146

5247
### Incident response and Endpoint Protection
5348
- Automated and On-demand Host lockdown, IP block, and remote-control console.
54-
- Antivirus, OSSEC and Wazuh Integration.
49+
- Antivirus Integration.
5550

5651
### Network and Host Intrusion detection
5752
- Rule-based Network Intrusion Detection.
5853
- Rule-based and heuristic analysis-based Host Intrusion detection System with ATP capabilities.
5954
- Network traffic, protocol, and DNS analysis.
6055

61-
### Access Rights Auditor
62-
- Active Directory Explorer.
63-
- User Activity and permissions tracking.
56+
### User Auditor
57+
- User Activity monitoring.
6458
- Suspicious activity monitoring.
6559

6660
### File Classification
@@ -114,16 +108,16 @@ provides the flexibility to build the entire stack from the ground by any advanc
114108

115109
### Audit and compliance support
116110
- Generate custom reportsfor audits or compliance checks and assessments.
117-
- Create compliance dashboardsfor continuous monitoring.
118-
- Leverage existing reportsforHIPAA, GLBA, GPDR, and SOC compliance.
111+
- Create compliance dashboards for continuous monitoring.
112+
- Leverage existing reports for HIPAA, GLBA, GPDR, and SOC compliance.
119113

120114
### Monitor and analyze security data
121115
- Build customized dashboards or use existing ones.
122116
- Explore systems data in nearreal-time and respond to incidents.
123117

124118
### Reduce downtime
125119
- Create up-time reports.
126-
- Review proactive alertsformisconfigurations or misconfigured systems.
120+
- Review proactive alerts for mis configurations or mis configured systems.
127121
- Monitor and analyze devices performance and resources utilization.
128122

129123
### Integrations

QuickStart.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ nav_order: 2
88

99
Getting started with UTMStack is straightforward. Follow this 3-step process:
1010

11-
1. **Installation**: Deploy UTMStack on your Master Server.
11+
1. **Installation**: Deploy UTMStack on your server.
1212
2. **Initial Configuration**: Set up essential settings, including SSL and email configurations.
1313
3. **DataSource Setup**: Configure a Windows Agent as a data source.
1414

1515
## 1. Install UTMStack
1616

17-
Before you begin, ensure your system meets the minimum requirements: **4 cores**, **12 GB of RAM**, and **150 GB of disk storage** to monitor up to **50 devices**.
17+
Before you begin, ensure your system meets the minimum requirements: **8 cores**, **16 GB of RAM**, and **150 GB of disk storage** to monitor up to **50 devices**.
1818

19-
Deploy the UTMStack Master Server, which oversees security operations and data collection.
19+
*** Integration Requirements *** : To ensure optimal system performance, certain additional requirements beyond the minimums must be considered. Each integration being introduced should reserve at least 1GB of space. This reservation is crucial to ensure proper data storage and efficient system operation as a whole.
20+
21+
*** Logging Volume Considerations ***: Furthermore, it's important to take into account the volume of logs generated and processed within 10-minute intervals. If this volume exceeds 1GB within any time interval, immediate communication with the support team is required. This communication is essential to ensure system stability and performance, as well as to address any potential issues related to log management.
22+
23+
Deploy the UTMStack Server, which oversees security operations and data collection.
2024

2125
### **Procedure**:
2226

@@ -77,8 +81,8 @@ Post installation, the first time you get access to UTMStack, its going to be re
7781
- **Mail Server Username**: The username for your email server.
7882
7983
- **Encryption type**: Choose the encryption protocol for your email server. Options include:
80-
- TLS
81-
- SSL
84+
- STARTTLS
85+
- SSL/TLS
8286
- NONE
8387
8488
Refer to the [Email Configuration Section](./UTMStackComponents/Configuration/ApplicationSetting) for a detailed walkthrough.

UTMStackComponents/Configuration/ApplicationSetting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Configure the email settings to send emails notifications for the alerts and inc
2626
- **Mail Server Username**: The username for your email server.
2727

2828
- **Encryption type**: Choose the encryption protocol for your email server. Options include:
29-
- TLS
30-
- SSL
31-
- NONE
29+
- STARTTLS
30+
- SSL/TLS
31+
- NONE
3232

3333

3434

UTMStackComponents/Dashboards/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Dashboards
4-
nav_order: 5
4+
nav_order: 6
55
has_children: true
66
---
77

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
title: Alert Management
4+
parent: Threat Intelligence
5+
nav_order: 1
6+
---
7+
8+
# Galaxy View
9+
10+
Welcome to the Threat Intelligence Section.
11+
12+
![Galaxy Search](./../Images/../../Images/galaxysearch.png)
13+
14+
## Introduction
15+
16+
Threat Intelligence is a proactive approach to cybersecurity that involves gathering, analyzing, and applying information about potential and current cyber threats. It provides organizations with valuable insights into the tactics, techniques, and procedures (TTPs) used by threat actors, as well as the vulnerabilities they exploit.
17+
18+
The primary goal of Threat Intelligence is to enhance an organization's ability to detect, prevent, and respond to cyber threats effectively. By understanding the evolving threat landscape, organizations can make informed decisions about allocating resources, strengthening defenses, and mitigating risks.
19+
20+
Threat Intelligence encompasses a wide range of data sources, including open-source intelligence (OSINT), commercial feeds, internal logs, and collaborative sharing with trusted partners and communities. This diverse set of information is then processed and analyzed to identify patterns, trends, and indicators of compromise (IOCs).
21+
22+
Effective Threat Intelligence programs involve not only collecting data but also contextualizing it within the organization's specific environment and business objectives. This contextualization helps prioritize threats based on their relevance and potential impact, allowing security teams to focus their efforts where they are most needed.

Installation/FederationServiceInstallation.md renamed to Upgrade/UpgradeFederationService.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: default
3-
title: Federation Service Installation
4-
parent: Installation
5-
nav_order: 7
3+
title: Upgrade Federation Service
4+
parent: Upgrade
5+
nav_order: 5
66
---
77

88
# UTMStack Federation Service Installation Guide
@@ -11,7 +11,6 @@ Welcome to the installation page for the Federated Master Deployment of UTMStack
1111

1212
This guide will walk you through the process of installing the UTMStack Federation Service (UTMStackFS) on an Ubuntu 20.04 LTS system. Please follow the steps below to ensure a successful installation.
1313

14-
1514
{:note}
1615
For more details contact Customer Service.
1716

0 commit comments

Comments
 (0)