From 11a66b635e34f63495645b3e926700ac79ebca83 Mon Sep 17 00:00:00 2001 From: Caleb Maclennan Date: Thu, 25 Nov 2021 23:49:33 +0300 Subject: [PATCH] readme: use full original binary name --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cd1ac7e..f02447f 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Let's assume the invitation file generated in the steps above have been transfer You can initialize the client with ```sh -sudo inn install /path/to/invitation.toml +sudo innernet install /path/to/invitation.toml ``` You can customize the network name if you want to, or leave it at the default. `innernet` will then connect to the `innernet` server via WireGuard, generate a new key pair, and register that pair with the server. The private key in the invitation file can no longer be used. @@ -57,13 +57,13 @@ You can customize the network name if you want to, or leave it at the default. ` If everything was successful, the new peer is on the network. You can run things like ```sh -sudo inn list +sudo innernet list ``` or ```sh -sudo inn list --tree +sudo innernet list --tree ``` to view the current network and all CIDRs visible to this peer. @@ -77,7 +77,7 @@ In order for peers from one CIDR to be able to contact peers in another CIDR, th With the admin peer we created above, let's add a new CIDR for some theoretical CI servers we have. ```sh -sudo inn add-cidr +sudo innernet add-cidr ``` The name is `ci-servers` and the CIDR is `10.60.64.0/24`, but for this example it can be anything. @@ -85,7 +85,7 @@ The name is `ci-servers` and the CIDR is `10.60.64.0/24`, but for this example i For now, we want peers in the `humans` CIDR to be able to access peers in the `ci-servers` CIDR. ```sh -sudo inn add-association +sudo innernet add-association ``` The CLI will ask you to select the two CIDRs you want to associate. That's all it takes to allow peers in two different CIDRs to communicate! @@ -93,13 +93,13 @@ The CLI will ask you to select the two CIDRs you want to associate. That's all i You can verify the association with ```sh -sudo inn list-associations +sudo innernet list-associations ``` and associations can be deleted with ```sh -sudo inn delete-associations +sudo innernet delete-associations ``` ### Enabling/Disabling Peers @@ -109,13 +109,13 @@ For security reasons, IP addresses cannot be re-used by new peers, and therefore Disable a peer with ```su -sudo inn disable-peer +sudo innernet disable-peer ``` Or re-enable a peer with ```su -sudo inn enable-peer +sudo innernet enable-peer ``` ### Specifying a Manual Endpoint @@ -123,13 +123,13 @@ sudo inn enable-peer The `innernet` server will try to use the internet endpoint it sees from a peer so other peers can connect to that peer as well. This doesn't always work and you may want to set an endpoint explicitly. To set an endpoint, use ```sh -sudo inn override-endpoint +sudo innernet override-endpoint ``` You can go back to automatic endpoint discovery with ```sh -sudo inn override-endpoint -u +sudo innernet override-endpoint -u ``` ### Setting the Local WireGuard Listen Port @@ -137,7 +137,7 @@ sudo inn override-endpoint -u If you want to change the port which WireGuard listens on, use ```sh -sudo inn set-listen-port +sudo innernet set-listen-port ``` or unset the port and use a randomized port with