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 May 15, 2020
1 parent ba57675 commit 6b54890
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
- **FakeTCP**: All TCP, UDP and ICMPv4 packets will be sent with a TCP header to bypass UDP blocking and UDP QoS. Inspired by [Udp2raw-tunnel](https://github.com/wangyu-/udp2raw-tunnel). The handshaking of TCP is also simulated.
- **Proxy ARP**: Reply ARP request as it owns the specified address which is not on the network.
- **Multiplexing and Multiple**: One client can handle multiple connections from different devices. And one server can serve multiple clients.
- **Cross Platform**: Works well with Windows and Linux, and macOS and others in theory.
- **Cross Platform**: Works well with Windows, macOS, Linux and others in theory.
- **Monitor**: Observe traffic on [IkaGo-web](http://ikago.ikas.ink)
- **Full Cone NAT**
- **Encryption**
- **KCP Support**
Expand Down Expand Up @@ -67,7 +68,7 @@ go run ./cmd/ikago-server -p [port]

`-log path`: (Optional) Log.

`-monitor port`: (Optional) Port for monitoring. If this value is set, IkaGo will server HTTP server on `localhost:port` and print statistics on it.
`-monitor port`: (Optional) Port for monitoring. If this value is set, IkaGo will host HTTP server on `localhost:port` and print JSON statistics on it. You can observe observe traffic on [IkaGo-web](http://ikago.ikas.ink).

### Client options

Expand Down
1 change: 1 addition & 0 deletions cmd/ikago-client/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,7 @@ func main() {
}()

log.Infof("Monitor on :%d\n", cfg.Monitor)
log.Infoln("You can now observe traffic on http://ikago.ikas.ink")
}

if len(sources) == 1 {
Expand Down
1 change: 1 addition & 0 deletions cmd/ikago-server/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,7 @@ func main() {
}()

log.Infof("Monitor on :%d\n", cfg.Monitor)
log.Infoln("You can now observe traffic on http://ikago.ikas.ink")
}

log.Infof("Proxy from :%d\n", cfg.Port)
Expand Down

0 comments on commit 6b54890

Please sign in to comment.