Skip to content

Commit

Permalink
feat: Netify informatics UI (#147)
Browse files Browse the repository at this point in the history 
Other changes:
* fix(monitoring): headline too short
* fix(build): bump sphinx release: make it work also on Fedora 41

Co-authored-by: Filippo Carletti <[email protected]>
  • Loading branch information
@gsanchietti @filippocarletti
gsanchietti and filippocarletti authored Jan 15, 2025
1 parent 4a3b7a4 commit fbc571e
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 83 deletions.
4 changes: 2 additions & 2 deletions monitoring.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@ Available charts are:
this char shows the IP addresses that have been blocked most frequently.
It is useful for identifying persistent threats or attack sources that should be investigated or blacklisted.

Real-time Traffic
---------------
Real-time traffic
-----------------

The Real-time traffic section shows data updated every 2 minutes. It's divided into three categories:

Expand Down
125 changes: 45 additions & 80 deletions netify_informatics.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,100 +4,77 @@
Netify Informatics
===================

`Netify Informatics <https://www.netify.ai/products/netify-informatics>`_ is a third-party cloud service that utilizes analytics and AI to convert local DPI metadata obtained from NethSecurity into high-level network intelligence and visibility. The solution provides insights into various aspects of network activity, including:
`Netify Informatics <https://www.netify.ai/products/netify-informatics>`_ is a third-party cloud service that utilizes analytics and AI to convert
local DPI metadata obtained from NethSecurity into high-level network intelligence.
The solution provides insights into various aspects of network activity, including:

* Device Discovery
* Geolocation
* Bandwidth Analysis
* Risk and Reputation Analysis
* Audit and Forensics
* Regulatory Compliance
* `Device Discovery <https://www.netify.ai/products/netify-informatics/device-discovery>`_
* `Bandwidth Monitoring <https://www.netify.ai/products/netify-informatics/bandwidth-monitoring>`_
* `Risk and Reputation Analysis <https://www.netify.ai/products/netify-informatics/risk-and-reputation>`_
* `Regulatory Compliance <https://www.netify.ai/products/netify-informatics/regulatory-compliance>`_
* Geolocation
* Audit and Forensics

Here are some examples of what Netify Informatics can do:
The service receives data from netifyd, the NethSecurity DPI engine which is enabled by default on the firewall.

You can try the service for free for 7 days.
After this period, you can choose the plan that best fits your needs.

`Bandwidth Monitoring <https://www.netify.ai/products/netify-informatics/bandwidth-monitoring>`_

`Device Discovery <https://www.netify.ai/products/netify-informatics/device-discovery>`_

`Risk and Reputation Analysis <https://www.netify.ai/products/netify-informatics/risk-and-reputation>`_

See `Netify Informatics Pricing <https://www.netify.ai/products/netify-informatics/pricing>`_ and `Netify Informatics FAQ <https://www.netify.ai/resources/faq>`_ for more information.

Before getting started
======================

Here is some fundamental information to better manage your installations on Netify Informatics.
You can granularly manage different customers, different locations of the same customer, and even different firewalls within the same location.The platform is organized with these elements.
Make sure to create an account on the Netify Informatics website, you can try the service for free for 7 days.
Register here: `Netify Registration <https://portal.netify.ai/register>`_

You can granularly manage different customers, different locations of the same customer, and even different firewalls within the same location.
The platform is organized with these elements.

Organization
------------
An organization is essentially a customer where we have at least one NethSecurity firewall, multiple organizations are supported.
* **Organization** : an organization is essentially a customer where we have at least one NethSecurity firewall, multiple organizations are supported.
* **Site**: the same organization (customer) might have an office in Rome, Florence, and Paris. A site is defined for each physical location to isolate
the data, multiple sites are supported.
* **Agent**: the agent represents your customer's NethSecurity unit. Netify supports multiple agents per site. If you have a simple network, one agent will
likely see all traffic flows on a site's network.

Site
-----
The same organization (customer) might have an office in Rome, Florence, and Paris. A site is defined for each physical location to isolate the mix of data, multiple sites are supported.

Agent
-----
The agent represents your customer's NethSecurity unit. Netify supports multiple agents per site. If you have a simple network, one agent will likely see all traffic flows on a site's network.
Connect NethSecurity to Netify Informatics
==========================================

How to Connect your NethSecurity to Netify Informatics
-------------------------------------------------------
Two steps are required to use the service:

* Enable metadata sending from NethSecurity
* Provision an agent on Netify Informatics.
1. Enable metadata sending from NethSecurity
2. Provision an agent on Netify Informatics.

.. warning:: It's mandatory to configure data sending on NethSecurity **first** and then provision the agent on the platform.

Enabling metadata sending
=========================

Each NethSecurity is associated with a unique code. To find the code for your NethSecurity, access the command line and enter the command:

``/usr/libexec/rpcd/ns.netifyd call status | jq .uuid -r``

The system will return a result similar to this:

``B3-GV-WQ-SD``

Enter the code into the Netify Informatics web console.

To enable data sending:

``/usr/libexec/rpcd/ns.netifyd call enable``

To disable data sending:

``/usr/libexec/rpcd/ns.netifyd call disable``
1. Enable metadata sending
--------------------------

Access the ``Netify Informatics`` page under the ``Monitoring`` section in the NethSecurity web interface.

Registration and provisioning
=============================
Enable the ``Send metadata to Netify Informatics`` option and click on ``Save``.

Visit the following page to create your account :

`Netify Registration <https://portal.netify.ai/register>`_


Agent provisioning
------------------

Once you have a registered account, click on the “Provision Agent Wizard” button. This will start a process where you will need to create the organization (the customer) and enable the agent using the code prevoiusly obtained on NethSecurity 8.

From this moment, Netify Informatics will start showing the data. You can then connect other firewalls of the same customer (same organization, same site or a different one) or create a new organization for a different customer.
Each NethSecurity is associated with a unique Agent UUID, something like this `B3-GV-WQ-SD`.
The code will be visible on the same page after enabling the send metadata option.

2. Provision the agent
-----------------------

Once you have a registered account and enabled the metadata sending on NethSecurity, you can provision the agent on the Netify Informatics platform:

Pricing
------------------
The service can be tried for free for 7 days. After this period, you can choose the plan that best fits your needs. See: `Netify Informatics Pricing <https://www.netify.ai/products/netify-informatics/pricing>`_
1. Copy the code obtained in the previous step and login to the Netify Informatics website.
2. Access the ``Provision Agent Wizard`` inside ``Deployment`` section.
3. Follow the instructions to create the organization (the customer) and paste the Agent UUID in the appropriate field to
enable the agent using the code obtained on NethSecurity.

From this moment, Netify Informatics will start showing the data. You can then connect other firewalls of the same customer
(same organization, same site or a different one) or create a new organization for a different customer.

Deployment Manager
==================


The Deployment section allows you to manage Agents, Sites, and Organizations.
The ``Deployment`` section inside Netify Informatics allows you to manage Agents, Sites, and Organizations.
While the management of Agents and Sites is relatively straightforward, the ``Organization Access`` section enables you to add additional members to your organization. This feature allows others to access the Netify panel and view all relevant data.

There are three available profiles:
Expand All @@ -114,16 +91,4 @@ The ``Viewer`` profile, likely the most commonly used, is for someone (e.g., an

To invite someone, simply click on ``Manage Organization``, enter their email address, and choose the desired profile. The person will receive an invite from Netify by email and will be able to create their own account.

.. note:: The profile type can be changed at any time by an administrator, allowing you to switch a person from Manager to Viewer, for example.



Regulatory Compliance
=====================

All informations about regulatory complince are available here:
`Netify Informatics Regulatory Compliance <https://www.netify.ai/products/netify-informatics/regulatory-compliance>`_

General FAQ
===========
Netify FAQ available here: `Netify Informatics FAQ <https://www.netify.ai/resources/faq>`_
.. note:: The profile type can be changed at any time by an administrator, allowing you to switch a person from Manager to Viewer, for example.
2 changes: 1 addition & 1 deletion requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx==5.0.2
sphinx==7.3.7
sphinx-book-theme==1.1.0
sphinx-copybutton==0.5.1
sphinx-intl==2.1.0
Expand Down

0 comments on commit fbc571e

Please sign in to comment.