diff options
| author | Aram Drevekenin <aram@poor.dev> | 2020-09-11 10:33:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-11 10:33:14 +0200 |
| commit | 27d3093d008f760b6cf9fe75f2782cc8fe74819f (patch) | |
| tree | 7d07d92218eb3dac349015c7bfe920afdc3e9e26 | |
| parent | 2e0f011285b6daf0e73a750f365224d850a25874 (diff) | |
docs(readme): windows installation instructions
| -rw-r--r-- | README.md | 13 |
1 files changed, 7 insertions, 6 deletions
@@ -58,9 +58,9 @@ cd /usr/ports/net-mgmt/bandwhich && make install clean #### Download a prebuilt binary If you're on linux, you could also get the generic binary from the releases. -#### Other Linux flavours +#### Windows / Other Linux flavours -`bandwhich` can be installed using the Rust package manager, cargo. If it's not in your distro repositories or the available version is too old, you can install it via [rustup](https://rustup.rs/). You can find additional installation instructions [here](https://doc.rust-lang.org/book/ch01-01-installation.html). +`bandwhich` can be installed using the Rust package manager, cargo. It might be in your distro repositories if you're on linux, or you can install it via [rustup](https://rustup.rs/). You can find additional installation instructions [here](https://doc.rust-lang.org/book/ch01-01-installation.html). The minimum supported Rust version is **1.39.0**. @@ -68,7 +68,8 @@ The minimum supported Rust version is **1.39.0**. cargo install bandwhich ``` -This installs `bandwhich` to `~/.cargo/bin/bandwhich` but you need root priviliges to run `bandwhich`. To fix that, there are a few options: +##### On Linux, after installing with cargo: +Cargo installs `bandwhich` to `~/.cargo/bin/bandwhich` but you need root priviliges to run `bandwhich`. To fix that, there are a few options: - Give the executable elevated permissions: ``sudo setcap cap_sys_ptrace,cap_dac_read_search,cap_net_raw,cap_net_admin+ep $(which bandwhich)`` - Run `sudo ~/.cargo/bin/bandwhich` instead of just `bandwhich` - Create a symlink: `sudo ln -s ~/.cargo/bin/bandwhich /usr/local/bin/` (or another path on root's PATH) @@ -76,6 +77,9 @@ This installs `bandwhich` to `~/.cargo/bin/bandwhich` but you need root privilig - Tell sudo to use your user's environment variables: `sudo -E bandwhich` - Pass the desired target directory to cargo: `sudo cargo install bandwhich --root /usr/local/bin/` +##### On Windows, after installing with cargo: +You might need to first install [npcap](https://nmap.org/npcap/) for capturing packets on windows. + #### OpenWRT To install `bandwhich` on OpenWRT, you'll need to compile a binary that would fit its processor architecture. This might mean you would have to cross compile if, for example, you're working on an `x86_64` and the OpenWRT is installed on an `arm7`. @@ -88,9 +92,6 @@ Here is an example of cross compiling in this situation: - Copy the binary files from `target/armv7-unknown-linux-musleabihf/debug/bandwhich` to the router using `scp` by running `scp bandwhich root@192.168.1.1:~/` (here, 192.168.1.1 would be the IP address of your router). - Finally enter the router using ssh and run the binary directly with `./bandwhich` -#### Windows -Unfortunately, windows is not supported at the moment - if you'd like to contribute a windows port, it would be very much welcome. - ### Usage ``` USAGE: |