Skip to content

Commit a237630

Browse files
Readme update
1 parent 943d870 commit a237630

1 file changed

Lines changed: 28 additions & 19 deletions

File tree

README.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
![logo](https://fastnetmon.com/wp-content/uploads/2018/01/cropped-new_logo_3var-e1515443553507-1-300x146.png)
2+
13
Community Edition
24
===========
3-
It's a high-performance DDoS detector/sensor built on top of multiple packet capture engines: NetFlow, IPFIX, sFlow, AF_PACKET (port mirror).
5+
FastNetMon - A high-performance DDoS detector/sensor built on top of multiple packet capture engines: NetFlow, IPFIX, sFlow, AF_PACKET (port mirror).
46

57
What do we do?
68
--------------
@@ -9,21 +11,22 @@ perform a configurable action to handle that event. These configurable actions i
911

1012
Project
1113
-------
12-
🌏️ [Official site](https://github.com/pavel-odintsov/fastnetmon)
13-
🌟️ [Author](https://pavel-odintsov.com/)
14-
📜️ [Author LinkedIN](https://www.linkedin.com/in/podintsov/)
14+
🌏️ [Official site](https://fastnetmon.com)
15+
⭐️ [FastNetMon Advanced, Commercial Edition](https://fastnetmon.com/product-overview/)
16+
🌟️ [FastNetMon Advanced, free one-month trial](https://fastnetmon.com/trial/)
17+
📜️ [FastNetMon Advanced and Community difference table](https://fastnetmon.com/compare-community-and-advanced/)
18+
📘️ [Detailed reference](https://fastnetmon.com/wp-content/uploads/2023/07/fastnetmon_community_book_20_jul_2023.pdf)
1519

1620
Legal
1721
--------------
1822

19-
Author and legal owner: Pavel Odintsov
20-
23+
By installing or using this software, you confirm that you have read and agree to the FastNetMon Community Edition T&Cs and Privacy Notice, which will apply to your installation and use of the software
2124

2225
### Installation
2326
- [Linux install instructions](https://fastnetmon.com/install/)
2427
- [macOS install instructions](https://formulae.brew.sh/formula/fastnetmon)
2528
- [FreeBSD port](https://www.freshports.org/net-mgmt/fastnetmon/)
26-
- [VyOS bundled support](https://vyos.io/)
29+
- [VyOS bundled support](https://fastnetmon.com/fastnetmon-community-on-vyos-rolling-1-3/)
2730

2831
Supported packet capture engines
2932
--------------------------------
@@ -36,37 +39,44 @@ Supported packet capture engines
3639
- Netmap (deprecated, still supported only for FreeBSD)
3740
- PF_RING / PF_RING ZC (deprecated, available only for CentOS 6 in 1.2.0)
3841

42+
You can check out the [comparison table](https://fastnetmon.com/docs/capture_backends/) for all available packet capture engines.
43+
3944
Features
4045
--------
4146
- Detects DoS/DDoS in as little as 1-2 seconds
4247
- Scales up to terabits on single server (sFlow, Netflow, IPFIX) or to 40G + in mirror mode
4348
- Trigger block/notify script if an IP exceeds defined thresholds for packets/bytes/flows per second
4449
- Thresholds can be configured per-subnet basis with the hostgroups feature
45-
- Email notifications about detected attack
50+
- [Email notifications](https://fastnetmon.com/docs/attack_report_example/) about detected attack
4651
- Complete IPv6 support
4752
- Prometheus support: system metrics and total traffic counters
4853
- Flow and packet export to Kafka in JSON and Protobuf format
49-
- Announce blocked IPs via BGP to routers with [ExaBGP](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L227) or [GoBGP](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L249) (recommended)
50-
- Full integration with [Clickhouse](https://github.com/pavel-odintsov/fastnetmon/blob/7f0ad9c6cd2db3856607aeed04b5e8125fad3124/src/fastnetmon.conf#L287) [InfluxDB](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L275) and [Graphite](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L314)
51-
- [API](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L357)
52-
- [Redis](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L211) integration
53-
- MongoDB protocol support compatible with native [MongoDB](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon.conf#L221) and [FerretDB](https://github.com/FerretDB/FerretDB)
54+
- Announce blocked IPs via BGP to routers with [ExaBGP](https://fastnetmon.com/docs/exabgp_integration/) or [GoBGP](https://fastnetmon.com/docs/gobgp-integration/) (recommended)
55+
- Full integration with [Clickhouse](https://github.com/pavel-odintsov/fastnetmon/blob/7f0ad9c6cd2db3856607aeed04b5e8125fad3124/src/fastnetmon.conf#L287) [InfluxDB](https://fastnetmon.com/docs/influxdb_integration/) and [Graphite](https://fastnetmon.com/docs/graphite_integration/)
56+
- [API](https://fastnetmon.com/docs/fastnetmon-community-api/)
57+
- [Redis](https://fastnetmon.com/docs/redis/) integration
58+
- MongoDB protocol support compatible with native [MongoDB](https://fastnetmon.com/docs/mongodb/) and [FerretDB](https://github.com/FerretDB/FerretDB)
5459
- VLAN untagging in mirror and sFlow modes
5560
- Capture attack fingerprints in PCAP format
5661

57-
We track [multiple](https://github.com/pavel-odintsov/fastnetmon/blob/5b960f76d6bf3dca2c80ef13a3776dfa544fb897/src/fastnetmon_logic.cpp#L3033) platform and environment-specific metrics to understand ways how our product is being used and prioritise development accordingly.
62+
We track [multiple](https://fastnetmon.com/docs-fnm-advanced/fastnetmon-usage-analytics/) platform and environment-specific metrics to understand ways how our product is being used and prioritise development accordingly.
5863

5964
Official support groups:
6065
-------
6166
- [Mailing list](https://groups.google.com/g/fastnetmon)
62-
- [Slack](https://join.slack.com/t/fastnetmon/shared_invite/zt-1i2cutd07-qEafHVoJvAOV5ODlHFsLoQ)
67+
- [Slack](https://slack.fastnetmon.com)
6368
- IRC: #fastnetmon at irc.libera.chat:6697 (TLS) [web client](https://web.libera.chat/?channels=#fastnetmon)
6469
- Telegram: [fastnetmon](https://t.me/fastnetmon)
65-
- Discord: [fastnetmon](https://discord.gg/Q4h9AUqFng)
70+
- Discord: [fastnetmon](https://discord.fastnetmon.com)
6671

6772
Follow us at social media:
6873
-------
69-
- [LinkedIn](https://www.linkedin.com/in/podintsov/)
74+
- [Twitter](https://twitter.com/fastnetmon)
75+
- [LinkedIn](https://www.linkedin.com/company/fastnetmon/)
76+
- [Facebook](https://www.facebook.com/fastnetmon/)
77+
78+
### Router integration instructions
79+
- [Juniper MX Routers](https://fastnetmon.com/docs/junos_integration/)
7080

7181
Complete integration with the following vendors
7282
--------------------------------
@@ -97,5 +107,4 @@ CI build status
97107
Upstream versions in different distributions
98108
--------------
99109

100-
[![FastNetMon upstream distro packaging status](https://repology.org/badge/vertical-allrepos/fastnetmon.svg)](https://repology.org/project/fastnetmon/versions)
101-
110+
[![FastNetMon upstream distro packaging status](https://repology.org/badge/vertical-allrepos/fastnetmon.svg)](https://repology.org/project/fastnetmon/versions)

0 commit comments

Comments
 (0)