Skip to content

Commit

Permalink
update Parameters page (#104)
Browse files Browse the repository at this point in the history
  • Loading branch information
yassine-ouaamou authored Jan 30, 2024
1 parent 70ca771 commit 4d8e29a
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 15 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/administration/assets/parameters_tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/administration/ontologies.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Taxonomies in OpenCTI refer to the structured classification systems that help in organizing and categorizing cyber threat intelligence data. They play a crucial role in the platform by allowing analysts to systematically tag and retrieve information based on predefined categories and terms.

Along with the Customization page, these pages allow the administrator to customize the platform.

## Labels

Labels in OpenCTI serve as a powerful tool for organizing, categorizing, and prioritizing data. Here’s how they can be used effectively:
Expand Down Expand Up @@ -35,6 +37,7 @@ You can add, edit, or delete kill chain phases in the settings page, and assign
## Vocabularies

Open vocabularies are sets of terms and definitions that are agreed upon by the CTI community. They help to standardize the communication documentation of cyber threat information.
This section allows you to customize a set of available fields by adding vocabulary. Almost all of the drop-down menus available in the entities can be modified from this panel.

Open vocabularies in OpenCTI are mainly based on the [STIX standard](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_izngjy1g98l2).

Expand Down
55 changes: 40 additions & 15 deletions docs/administration/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,65 @@ This part of the interface wil let you configure global platform settings, like

It will also give you important information about the platform.

## Configuration
## The "Configuration" section
![parameters_configuration.png](assets/parameters_configuration.png)

Configure global platform settings, like title, favicon, etc.
This section allows the administrator to edit the following settings:

- Platform title
- Platform favicon URL
- Sender email address: email address displayed as sender when sending notifications. The technical sender is defined in the [SMTP configuration](../deployment/configuration.md#smtp-service).
- Theme
- Language
- Hidden entity types: allows you to customize which types of entities you want to see or hide in the platform. This can help you focus on the relevant information and avoid cluttering the platform with unnecessary data.

## OpenCTI Platform
![parameters_platform](assets/parameters_platform.png)

This is where the [Enterprise edition](enterprise.md) can be enabled.

This section gives important information about the platform like the used version, the edition, the architecture mode (can be Standalone or Cluster) and the number used nodes.

Important information about the platform.
Through the "Remove Filigran logos" toggle, the administrator has the option to hide the Filigran logo on the login page and the sidebar.

It's also the place to activate the [Enterprise edition](enterprise.md)

## Platform Announcement

This section gives you the possibility to set and display Announcements in the platform. Those announcements will be visible to every user in the platform, on top of the interface.

They can be used to inform all your users' community of important information, like a scheduled downtime, an incoming upgrade, or even an important tips regarding the usage of the platform.
They can be used to inform some of your users or all of important information, like a scheduled downtime, an incoming upgrade, or even to share important tips regarding the usage of the platform.

![Broadcast message configuration](assets/broadcast_message_configuration.png)

An Announcement can be accompanied by a "Dismiss” button. When click by a user, it makes the message disappear for this user.
An Announcement can be accompanied by a "Dismiss” button. When clicked by a user, it makes the message disappear for this user.

![Broadcast message display dismissible](assets/broadcast_message_display_dismissible.png)
![parameters_broadcast_message_dismissible](assets/parameters_broadcast_message_dismissible.png)

This option can be deactivated to have a permanent Announcement.
This option can be deactivated to have a permanent announcement.

![Broadcast message display not dismissible](assets/broadcast_message_display_notdismissible.png)
![parameters_broadcast_message_non-dismissible](assets/parameters_broadcast_message_non-dismissible.png)
⚠️ Only one announcement is shown at a time, with priority given to dismissible ones. If there are no dismissible announcements, the most recent non-dismissible one is shown.

⚠️ Only one Announcement is displayed at a time. Dismissible Announcements are displayed first, then the latest not dismissible Announcement.

## Analytics
## Third-party Analytics

!!! tip "Enterprise edition"

Analytics is available under the "Filigran entreprise edition" license.

[Please read the dedicated page to have all information](enterprise.md)
[Please read the dedicated page to have more information](enterprise.md)

This is where you can configure analytics providers. At the moment only Google analytics v4 is supported.

## Theme customization

In this section, the administrator can customize the two OpenCTI themes
![parameters_theme_customization](assets/parameters_theme_customization.png)


## Tools

This section informs the administrator of the statuses of the different managers used in the Platform. More information about the managers can be found [here](../deployment/managers.md).
It shows also the used versions of the search engine database, RabbitMQ and Redis.

In cluster mode, the fact that a manager appears as enabled means that it is active in at least one node.

Configure analytics providers (at the moment only Google analytics v4).
![parameters_tools](assets/parameters_tools.png)

0 comments on commit 4d8e29a

Please sign in to comment.