Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ADDITIONAL-USE-GRANT.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This grant applies to modified versions of the Software. Anyone who distributes

## 7. Registration and commercial licenses

The licensor sets the fee, scope, node count, term and support for each Registration License or commercial license case by case, and may grant them free of charge. Contact: https://github.com/githubflyideas/traffic66
The licensor sets the fee, scope, node count, term and support for each Registration License or commercial license case by case, and may grant them free of charge. Contact: route66traffic66@gmail.com

## 8. Violations

Expand Down Expand Up @@ -128,7 +128,7 @@ La présente autorisation s'applique aux versions modifiées du Logiciel. Quicon

## 7. Licences d'enregistrement et licences commerciales

Le concédant fixe au cas par cas le prix, le périmètre, le nombre de nœuds, la durée et le support de chaque Licence d'enregistrement ou licence commerciale, et peut les accorder gratuitement. Contact : https://github.com/githubflyideas/traffic66
Le concédant fixe au cas par cas le prix, le périmètre, le nombre de nœuds, la durée et le support de chaque Licence d'enregistrement ou licence commerciale, et peut les accorder gratuitement. Contact : route66traffic66@gmail.com

## 8. Violations

Expand Down Expand Up @@ -202,7 +202,7 @@ Esta concesión se aplica a las versiones modificadas del Software. Quien distri

## 7. Licencias de registro y licencias comerciales

El licenciante fija caso por caso la tarifa, el alcance, el número de nodos, el plazo y el soporte de cada Licencia de registro o licencia comercial, y puede concederlas gratuitamente. Contacto: https://github.com/githubflyideas/traffic66
El licenciante fija caso por caso la tarifa, el alcance, el número de nodos, el plazo y el soporte de cada Licencia de registro o licencia comercial, y puede concederlas gratuitamente. Contacto: route66traffic66@gmail.com

## 8. Infracciones

Expand Down Expand Up @@ -276,7 +276,7 @@ Traffic66("本软件")以 PolyForm Noncommercial License 1.0.0("基础许

## 7. 注册许可与商业许可

注册许可或商业许可的费用、范围、节点数、期限和支持内容由许可方逐案决定,也可以免费授予。联系方式:https://github.com/githubflyideas/traffic66
注册许可或商业许可的费用、范围、节点数、期限和支持内容由许可方逐案决定,也可以免费授予。联系方式: route66traffic66@gmail.com

## 8. 违约

Expand Down Expand Up @@ -350,7 +350,7 @@ Traffic66(以下「本ソフトウェア」)は PolyForm Noncommercial Licen

## 7. 登録ライセンスと商用ライセンス

登録ライセンスまたは商用ライセンスの料金、範囲、ノード数、期間およびサポートは、許諾者が個別に定め、無償で許諾することもあります。連絡先:https://github.com/githubflyideas/traffic66
登録ライセンスまたは商用ライセンスの料金、範囲、ノード数、期間およびサポートは、許諾者が個別に定め、無償で許諾することもあります。連絡先: route66traffic66@gmail.com

## 8. 違反

Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
The release notes on GitHub are taken from this file: the section whose
heading is the version number.

## 2.3.7

- Documentation only: simpler README opening (one-line description, screenshot and a single copy-and-run command block, Windows and device-port notes).
- License contact updated to route66traffic66@gmail.com (Additional Use Grant and its translations, manuals).

## 2.3.6

- Documentation only: rewritten README with per-platform first-run steps (Windows: Npcap, opening a terminal, admin terminal for local capture), task-based commands and a short FAQ (including NetFlow v9/IPFIX template and active timeout advice).
Expand Down
125 changes: 38 additions & 87 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,118 +1,69 @@
**English** | [中文](docs/README.zh.md) | [हिन्दी](docs/README.hi.md) | [Español](docs/README.es.md) | [العربية](docs/README.ar.md) | [Français](docs/README.fr.md) | [বাংলা](docs/README.bn.md) | [Português](docs/README.pt.md) | [Русский](docs/README.ru.md) | [Bahasa Indonesia](docs/README.id.md) | [اردو](docs/README.ur.md) | [Deutsch](docs/README.de.md) | [日本語](docs/README.ja.md) | [Tiếng Việt](docs/README.vi.md) | [한국어](docs/README.ko.md)

# traffic66 — NetFlow, sFlow and IPFIX collector and traffic analyzer
# traffic66

Who uses the bandwidth, where the traffic goes, and whether the numbers match the devices' own interface counters. One program, web UI and terminal UI.
A single-binary NetFlow / sFlow / IPFIX collector and traffic analyzer, with a web UI and a terminal UI.

## Quick start
<img src="docs/images/overview.png" alt="Overview" width="100%">

Download: [Releases](https://github.com/githubflyideas/traffic66/releases/latest)
Run: `traffic66.exe` (Windows) or `./traffic66` (Linux, macOS)
Open: `http://<this computer's IP>:8066` (on the same computer: http://localhost:8066)
Just download and run

**Login: user `admin`, password `traffic66` (you set a new password at first sign-in)**
```bash
# Linux x86_64 (also: linux-arm64, darwin-amd64, darwin-arm64 .tar.gz, windows-amd64.zip)
wget https://github.com/githubflyideas/traffic66/releases/latest/download/traffic66-linux-amd64.tar.gz
tar -zxvf traffic66-linux-amd64.tar.gz
cd traffic66-linux-amd64

Devices send to this computer's IP: sFlow UDP 6343, NetFlow v5/v9 UDP 2055, IPFIX UDP 4739.
# run, then open http://localhost:8066 (admin / traffic66, change at first login)
./traffic66

### Windows
# capture this machine's traffic (names from: ./traffic66 interfaces)
sudo ./traffic66 -capture eth0

1. Download `traffic66-windows-amd64.zip` and unzip it, for example to `C:\traffic66`.
2. To capture this PC's own traffic, install [Npcap](https://npcap.com/#download) first (keep the defaults). Not needed for sFlow/NetFlow/IPFIX.
3. Double-click `traffic66.exe` to start with the defaults (no options). For any command with options, open a terminal:
- Normal: open the folder, type `cmd` in the address bar and press Enter.
- Local capture needs an admin terminal: right-click Start > **Terminal (Admin)**, then `cd C:\traffic66`.
4. Run `traffic66.exe` (in PowerShell: `.\traffic66.exe`).
5. Open http://localhost:8066 and sign in.
# run in background
nohup ./traffic66 > traffic66.log 2>&1 &

### Linux
# change the admin password
./traffic66 passwd
```

1. Download and unzip:
```
tar xzf traffic66-linux-amd64.tar.gz
cd traffic66-linux-amd64
```
(ARM: `traffic66-linux-arm64.tar.gz`)
2. Run `./traffic66` (local capture needs `sudo`).
3. Open `http://<server IP>:8066` and sign in.
Windows: unzip `traffic66-windows-amd64.zip`, install [Npcap](https://npcap.com/#download) for local capture, then in an admin `cmd` in that folder run `traffic66.exe -capture Wi-Fi` (names from `traffic66.exe interfaces`).

### macOS

1. Download `traffic66-darwin-arm64.tar.gz` (Apple silicon) or `traffic66-darwin-amd64.tar.gz` (Intel), then:
```
tar xzf traffic66-darwin-arm64.tar.gz
cd traffic66-darwin-arm64
xattr -dr com.apple.quarantine .
```
2. Run `./traffic66` (local capture needs `sudo`).
3. Open http://localhost:8066 and sign in.
Devices: send sFlow to UDP 6343, NetFlow v5/v9 to UDP 2055, IPFIX to UDP 4739 on this host.

## Screenshots

<img src="docs/images/overview.png" alt="Overview" width="49%"> <img src="docs/images/topn.png" alt="Top 66" width="49%">
<img src="docs/images/topn.png" alt="Top 66" width="49%">

<img src="docs/images/geo.png" alt="Geo & networks" width="49%"> <img src="docs/images/interfaces.png" alt="Interface check" width="49%">

<img src="docs/images/tui-top.png" alt="TUI" width="49%">

## What do you want to do?

Capture this computer's traffic (Windows, admin terminal, Npcap installed):
`traffic66.exe -capture Wi-Fi`
Use the card name or number from `traffic66.exe interfaces`, e.g. `-capture Ethernet`.

Capture this computer's traffic (Linux / macOS):
`sudo ./traffic66 -capture eth0`
On macOS usually `en0`. Names come from `./traffic66 interfaces`.

Receive sFlow from a switch:
`./traffic66`
Nothing to add: configure the switch to send sFlow to this computer's IP, UDP 6343.

Receive NetFlow or IPFIX from a router:
`./traffic66`
Configure the router to export to this computer's IP, UDP 2055 (NetFlow) or 4739 (IPFIX).

Use another collector port:
`./traffic66 -listen sflow=:6343,netflow=:9995,ipfix=:4739`
Here NetFlow is received on 9995. Every port accepts every protocol.

Change the web port:
`./traffic66 -addr :9000`
Then open `http://<IP>:9000`.

Bind to one IP address only:
`./traffic66 -addr 192.168.1.10:8066 -listen sflow=192.168.1.10:6343,netflow=192.168.1.10:2055,ipfix=192.168.1.10:4739`
Web UI and collectors listen only on 192.168.1.10.

Set or change the admin password:
`./traffic66 passwd`
Prompts for a new password (Windows: `traffic66.exe passwd`).

Keep data in another directory:
`./traffic66 -data /var/lib/traffic66`
Default: `traffic66-data` next to the program.

Terminal UI:
`./traffic66 tui`
Run on the traffic66 machine; for a remote one add `-server http://192.168.1.10:8066`.
## Parameters

Try without devices:
`./traffic66 demo`
Starts with simulated devices.
```bash
./traffic66 -capture eth0 # capture a local interface (name or number)
./traffic66 -addr :9000 # web UI port / bind address (default :8066)
./traffic66 -listen sflow=:6343,netflow=:9995,ipfix=:4739 # collector ports
./traffic66 -data /var/lib/traffic66 # data directory (default ./traffic66-data)
./traffic66 interfaces # list capturable interfaces
./traffic66 passwd # set the admin password
./traffic66 tui # terminal UI (remote: -server http://IP:8066)
./traffic66 demo # try with simulated devices
```

On Windows, write `traffic66.exe` instead of `./traffic66` (PowerShell: `.\traffic66.exe`).
macOS: run `xattr -dr com.apple.quarantine .` in the folder first. PowerShell: use `.\traffic66.exe`.

## FAQ

**No data showing.** Check that the device exports to this computer's IP and the right UDP port (6343 / 2055 / 4739), that the firewall allows those UDP ports inbound, and wait a minute: NetFlow/IPFIX devices often send records only after flows end or time out.
NetFlow v9 and IPFIX need the device's template before records can be decoded, and long flows are exported only at the active timeout: set template refresh and active timeout to 60 s on the device. NetFlow v5, sFlow and local capture show up immediately.
**No data?** Check the device exports to this host and port, and the firewall allows that UDP port. NetFlow v9/IPFIX need a template first and long flows appear at the active timeout: set both to 60 s on the device.

**Can't find the interface name.** Run `traffic66.exe interfaces` (Windows) or `./traffic66 interfaces` (Linux, macOS); it lists the names and numbers `-capture` accepts.
**Interface name?** `./traffic66 interfaces`

**Forgot the password.** Stop traffic66 and run `./traffic66 passwd` (add `-data DIR` if you use one) to set a new one.
**Forgot the password?** Stop traffic66 and run `./traffic66 passwd` (add `-data DIR` if used).

## Full manual
## Manual

In the web UI: **Help** in the menu. On GitHub: [MANUAL.md](docs/MANUAL.md)
Web UI: **Help** in the menu. GitHub: [MANUAL.md](docs/MANUAL.md)

Free for evaluation and for organizations under 100 people ([licence](LICENSE.md)).
2 changes: 1 addition & 1 deletion cmd/traffic66/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ var version = ""
// CHANGELOG.md. TestDevVersionMatchesChangelog keeps the two in step: the
// default used to be a hardcoded 0.1.0-dev, and because nothing checked it
// it stayed that way for two major versions.
const devVersion = "2.3.6"
const devVersion = "2.3.7"

func init() {
if version == "" {
Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ días de uso en producción; vender, alojar para terceros o productos
competidores requieren una licencia comercial. Nunca se desactiva nada. El
pie de cada página muestra el número de instalación de 8 dígitos; envíelo
al autor y ponga el `license.json` que reciba en el directorio de datos.
Contacto: <https://github.com/githubflyideas/traffic66>.
Contacto: <route66traffic66@gmail.com>.

<a id="11-security-sizing-troubleshooting"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ tiers ou les produits concurrents nécessitent une licence commerciale. Rien
n'est jamais désactivé. Le bas de chaque page affiche le numéro
d'installation à 8 chiffres ; envoyez-le à l'auteur et placez le
`license.json` reçu en retour dans le répertoire de données. Contact :
<https://github.com/githubflyideas/traffic66>.
<route66traffic66@gmail.com>.

<a id="11-security-sizing-troubleshooting"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ Linux では root か `setcap cap_net_raw,cap_net_admin+ep`、macOS では root

### ライセンス

[PolyForm Noncommercial License 1.0.0](../LICENSE.md) と [Traffic66 Additional Use Grant](../ADDITIONAL-USE-GRANT.md)(英語版が正本)のもとでのソースアベイラブルです。評価用途と 100 人未満の組織は無料。それより大きな組織は本番利用 30 日後に登録が必要です。販売、他者向けのホスティング、競合製品には商用ライセンスが必要です。機能が止まることは一切ありません。各ページの下部に 8 桁のインストール番号が表示されるので、それを作者に送り、返ってきた `license.json` をデータディレクトリに置いてください。連絡先:<https://github.com/githubflyideas/traffic66>。
[PolyForm Noncommercial License 1.0.0](../LICENSE.md) と [Traffic66 Additional Use Grant](../ADDITIONAL-USE-GRANT.md)(英語版が正本)のもとでのソースアベイラブルです。評価用途と 100 人未満の組織は無料。それより大きな組織は本番利用 30 日後に登録が必要です。販売、他者向けのホスティング、競合製品には商用ライセンスが必要です。機能が止まることは一切ありません。各ページの下部に 8 桁のインストール番号が表示されるので、それを作者に送り、返ってきた `license.json` をデータディレクトリに置いてください。連絡先:<route66traffic66@gmail.com>。

<a id="11-security-sizing-troubleshooting"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ larger organizations register after 30 days of production use; selling,
hosting for others or competing products need a commercial licence. The foot
of each page shows the 8-digit installation number; send it to the author,
and put the `license.json` you get back in the data directory. Contact:
<https://github.com/githubflyideas/traffic66>.
<route66traffic66@gmail.com>.

## 11. Security, sizing, troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ Linux 需要 root 或 `setcap cap_net_raw,cap_net_admin+ep`,macOS 需要 root

### 许可

以 [PolyForm Noncommercial License 1.0.0](../LICENSE.md) 和 [Traffic66 Additional Use Grant](../ADDITIONAL-USE-GRANT.md) 公开源码(以英文文本为准):评估免费,少于 100 人的组织免费;更大的组织在生产使用 30 天后需注册;销售、为他人托管或提供竞争性产品需要商业许可。任何功能都不会被关闭。每个页面底部显示 8 位安装编号;把它发给作者,并把收到的 `license.json` 放进数据目录。联系方式:<https://github.com/githubflyideas/traffic66>。
以 [PolyForm Noncommercial License 1.0.0](../LICENSE.md) 和 [Traffic66 Additional Use Grant](../ADDITIONAL-USE-GRANT.md) 公开源码(以英文文本为准):评估免费,少于 100 人的组织免费;更大的组织在生产使用 30 天后需注册;销售、为他人托管或提供竞争性产品需要商业许可。任何功能都不会被关闭。每个页面底部显示 8 位安装编号;把它发给作者,并把收到的 `license.json` 放进数据目录。联系方式:<route66traffic66@gmail.com>。

<a id="11-security-sizing-troubleshooting"></a>

Expand Down
Loading