readme corrections

pull/2/head
knaccc 5 years ago
parent 990c09f5b0
commit fcc715718a

@ -70,32 +70,34 @@ Press Ctrl-C to gracefully shut down the router (or send the SIGINT signal to th
## Tunnel control
Call the `dist/linux/router/bin/tunnel-control.sh` script as follows to create and destroy tunnels:
#### Listen for i2p connections and forward them to the specified host and port. Returns a newly created destination public key.
`dist/linux/router/bin/tunnel-control.sh server.create <host> <port>`
`tunnel-control.sh server.create <host> <port>`
#### Close the tunnel listening for connections on the specified port. Returns "OK".
#### Close the tunnel listening for connections on the specified destination public key. Returns "OK".
`dist/linux/router/bin/tunnel-control.sh server.destroy <i2p destination public key>`
`tunnel-control.sh server.destroy <i2p destination public key>`
#### Create a tunnel that listens for connections on localhost and forwards connections over I2P to the specified destination public key. Returns a newly created localhost port number.
`dist/linux/router/bin/tunnel-control.sh client.create <i2p destination public key>`
`tunnel-control.sh client.create <i2p destination public key>`
#### Close the tunnel listening for connections on the specified port. Returns "OK".
`dist/linux/router/bin/tunnel-control.sh client.destroy <port>`
`tunnel-control.sh client.destroy <port>`
#### Create a socks tunnel, listening on the specified port
`dist/linux/router/bin/tunnel-control.sh socks.create <port>`
`tunnel-control.sh socks.create <port>`
#### Destroy the socks tunnel listening on the specified port
`dist/linux/router/bin/tunnel-control.sh socks.destroy <port>`
`tunnel-control.sh socks.destroy <port>`
## Watch the I2P log for messages

@ -29,7 +29,7 @@ public class Main {
p.put("router.sharePercentage","80");
// allow default properties to be overridden via command line args, e.g. --i2p.dir.base=/usr/share/i2p
for(String arg : args) {
for(var arg : args) {
if(arg.startsWith("--")) {
String[] s = arg.split("=");
String argName = s[0].substring("--".length());

@ -33,7 +33,7 @@ public class TunnelControl implements Runnable {
// listen for socket connections to the tunnel controller.
// listen for the commands on port 30000:
// server.create <host> <port> // returns a newly created destination public key, which will listen for i2p connections and forward them to the specified host and port
// server.destroy <i2p destination public key> // closes the tunnel listening for connections on the specified port, and returns OK
// server.destroy <i2p destination public key> // closes the tunnel listening for connections on the specified destination public key, and returns OK
// client.create <i2p destination public key> // returns a newly created localhost port number, where connections will be sent over I2P to the destination public key
// client.destroy <port> // closes the tunnel listening for connections on the specified port, and returns OK
// socks.create <port> // creates a socks proxy listening on the specified port

Loading…
Cancel
Save