Skip to content

Latest commit

 

History

History
130 lines (104 loc) · 3.54 KB

README.md

File metadata and controls

130 lines (104 loc) · 3.54 KB
Raw

Language : 🇺🇸 English | 🇨🇳 简体中文

netop

Docker Pulls Docker Image Size Docker Image Version (latest by date)

GitHub Workflow Status Last Commit LICENSE

Overview

netop is a terminal command line interface that can customize the filter network traffic rule 🎯

Features

  • Use the bpf rule filter
  • Multi-rule switching
  • Real-time rate
  • Total traffic
  • Response UI
  • Resource occupation is small, rust Written
  • Support docker deployment

Installation

Docker

docker run -it --rm --net=host zingerbee/netop

Cargo

need rust and pcap, detail look at How to build

# install
sudo cargo install netop
# and then run
netop
# or designated network interface card running
netop -n eth0

NetBSD

On NetBSD there's an official package available. To install a pre-compiled binary, simply run

pkgin install netop

Or, if you prefer to build it from source,

cd /usr/pkgsrc/net/netop
make install

Arch Linux

AUR

Thanks to @kemelzaidan for the contribution!

How to use

  • Press e to enter edit mode input bpf rule, and then press enter
  • Press Esc to exit edit mode
  • Use the <- or -> to switch between different rules
  • Not in edit mode, press dd to delete current rule
  • Not in edit mode, press q to quit

View help

netop -h
# docker
docker run -it --rm --net=host zingerbee/netop -h

Output as follows

netop 0.1.4

USAGE:
    netop [OPTIONS]

OPTIONS:
    -h, --help           Print help information
    -n, --name <NAME>    Name of Network Interface Card
    -V, --version        Print version information

Designated network interface card running

The parameter is name of network interface card

*unix: Use ifconfig to view network interface cards information

windows: Use ipconfig to view network interface cards information

netop -n eth0
# docker
docker run -it --rm --net=host zingerbee/netop -n eth0

How to build from source

Development environment

  • It is best to be root user, pcap requires permissions
  • rust >= 1.40.0
  • pcap
    • Ubuntu、Debian: apt install libpcap-dev
    • MacOS: installed by default
    • Windows: Download the WinPcap Developer's Pack. Add the /Lib or /Lib/x64 folder to your LIB environment variable.
sudo cargo install --path .
# or
sudo cargo run

Found an issue or have a proposal

Create an issue

Release Notes

SEE CHANGELOG