Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zhxie committed Mar 15, 2020
1 parent 66971e3 commit 6bf53aa
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ _IkaGo is currently under development and may not suitable for production._

## Dependencies

1. pcap like [Npcap](http://www.npcap.org/) or WinPcap in Windows, and libpcap in macOS or Linux.
1. pcap like [Npcap](http://www.npcap.org/) or WinPcap in Windows, libpcap in macOS or Linux.

## Usage

Expand All @@ -37,13 +37,13 @@ go run ./cmd/ikago-server -p [port]

`-list-devices`: (Optional, exclusively) List all valid pcap devices in current computer.

`-c`: (Optional, exclusively) Configuration file. An example of configuration file is [here](https://github.com/zhxie/ikago/blob/master/configs/config.json).
`-c`: (Optional, exclusively) Configuration file. An example of configuration file is [here](/configs/config.json).

`-listen-devices devices`: (Optional) pcap devices for listening, use comma to separate multiple devices. If this value is not set, all valid pcap devices will be used. For example, `-listen-devices eth0,wifi0,lo`.

`-upstream-device device`: (Optional) pcap device for routing upstream to. If this value is not set, the first valid pcap device with the same domain of gateway will be used.

`-method method`: (Optional) Method of encryption, can be `plain`, `aes-128-gcm`, `aes-192-gcm`, `aes-256-gcm`, `chacha20-poly1305`, `xchacha20-poly1305`. Default as `plain`.
`-method method`: (Optional) Method of encryption, can be `plain`, `aes-128-gcm`, `aes-192-gcm`, `aes-256-gcm`, `chacha20-poly1305` or `xchacha20-poly1305`. Default as `plain`.

`-password password`: (Optional) Password of the encryption, must be set only when method is not `plain`.

Expand Down Expand Up @@ -72,3 +72,7 @@ go run ./cmd/ikago-server -p [port]

- [ ] Retransmission and out of order packets detection
- [ ] Bypass filters

## License

IkaGo is licensed under [the MIT License](/LICENSE).

0 comments on commit 6bf53aa

Please sign in to comment.