some final cmdrun cleanup

This commit is contained in:
mx
2023-04-13 13:36:20 +02:00
committed by Jon Häggblad
parent 9bbe4a96d0
commit 843bd4f4fa
4 changed files with 8 additions and 30 deletions
@@ -69,7 +69,7 @@ You can check that your binaries are properly compiled with:
~~~admonish example collapsible=true title="Console output"
```
# <!-- cmdrun ../../../../target/release/nym-socks5-client --help -->
<!-- cmdrun ../../../../target/release/nym-socks5-client --help -->
```
~~~
@@ -88,7 +88,7 @@ Before you can use the client, you need to initalise a new instance of it, which
~~~admonish example collapsible=true title="Console output"
```
# <!-- cmdrun ../../../../target/release/nym-socks5-client init --id docs-example --provider Entztfv6Uaz2hpYHQJ6JKoaCTpDL5dja18SuQWVJAmmx.Cvhn9rBJw5Ay9wgHcbgCnVg89MPSV5s2muPV2YF1BXYu@Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf -->
<!-- cmdrun ../../../../target/release/nym-socks5-client init --id docs-example --provider Entztfv6Uaz2hpYHQJ6JKoaCTpDL5dja18SuQWVJAmmx.Cvhn9rBJw5Ay9wgHcbgCnVg89MPSV5s2muPV2YF1BXYu@Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf -->
```
~~~
@@ -118,13 +118,6 @@ You can run the initalised client by doing this:
./nym-socks5-client run --id docs-example
```
~~~admonish example collapsible=true title="Console output"
```
# <!-- cmdrun ../../../../target/release/nym-socks5-client run --id docs-example -->
```
~~~
## Using your Socks5 Client
After completing the steps above, your local Socks5 Client will be listening on `localhost:1080` ready to proxy traffic to the Network Requester set as the `--provider` when initialising.
@@ -190,11 +190,11 @@ In some applications, e.g. where people are chatting with friends who they know,
}
```
If that fits your security model, good. However, it may be the case that you want to send **anonymous replies using Single Use Reply Blocks (SURBs)**.
If that fits your security model, good. However, will probably be the case that you want to send **anonymous replies using Single Use Reply Blocks (SURBs)**.
You can read more about SURBs [here](../architecture/traffic-flow.md#private-replies-using-surbs) but in short they are ways for the receiver of this message to anonymously reply to you - the sender - without them having to know your nym address.
Your client will send along a number of `replySurbs` to the recipient of the message. These are pre-addressed Sphinx packets that the recipient can write to, but not view the address. If the recipient is unable to fit the response data into the bucket of SURBs sent to it, it will use a SURB to request more SURBs be sent to it.
Your client will send along a number of `replySurbs` to the recipient of the message. These are pre-addressed Sphinx packets that the recipient can write to the payload of (i.e. write response data to), but not view the address. If the recipient is unable to fit the response data into the bucket of SURBs sent to it, it will use a SURB to request more SURBs be sent to it from your client.
```json
{
@@ -97,21 +97,6 @@ When running the above commands, the `./nym-network-requester --help ` command c
<!-- cmdrun ../../../../target/release/nym-network-requester --help -->
```
~~~
## Running your network requester
Once an network-requester has been initialized, we can start it with the following command:
```
./nym-network-requester run --id example
```
Expected output:
~~~admonish example collapsible=true title="Console output"
```
<!-- cmdrun ../../../../target/release/nym-network-requester run --id example -->
```
~~~
## Upgrading your network requester
You can upgrade your network requester by following these steps:
@@ -120,7 +105,7 @@ You can upgrade your network requester by following these steps:
* replace the old binary with the new binary
* restart your service using the commands in the previous section of the document
### Upgrading to version 1.1.10
### Upgrading to >= v1.1.10 from <v1.1.9
In the previous version of the network-requester, users were required to run a nym-client along side it to function. As of `v1.1.10`, the network-requester now has a nym client embedded into the binary, so it can run standalone.
@@ -208,7 +193,7 @@ For more information about your requester's port configuration, check the [reque
## Using your network requester
The next thing to do is: use your requester, share its address with friends (or whoever you want to help privacy-enhance their app traffic). Is this safe to do? If it was an open proxy, this would be unsafe, because any Nym user could make network requests to any system on the internet.
The next thing to do is use your requester, share its address with friends (or whoever you want to help privacy-enhance their app traffic). Is this safe to do? If it was an open proxy, this would be unsafe, because any Nym user could make network requests to any system on the internet.
To make things a bit less stressful for administrators, the Network Requester drops all incoming requests by default. In order for it to make requests, you need to add specific domains to the `allowed.list` file at `$HOME/.nym/service-providers/network-requester/allowed.list`.
+2 -2
View File
@@ -53,10 +53,10 @@ The best place to start if you just want to quickly get a basic frontend up and
As you can see, all that is required to create an ephemeral keypair and connect to the mixnet is creating a client and then subscribing to the mixnet events coming down the websocket, and adding logic to deal with them.
#### Parcel
If you don't want to use `Webpack` as your app bundler, we have an example with `Parcel` located at `[examples/parcel](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/parcel/)`.
If you don't want to use `Webpack` as your app bundler, we have an example with `Parcel` located at [`examples/parcel/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/parcel/).
#### Create React App
For React developers we have an example which is a basic React app scaffold with the additional logic for creating a client and subscribing to mixnet events in `[examples/react-webpack-with-theme-example](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/)`.
For React developers we have an example which is a basic React app scaffold with the additional logic for creating a client and subscribing to mixnet events in [`examples/react-webpack-with-theme-example/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/).
### Developers: think about what you're sending (and importing)!
Think about what information your app sends. That goes for whatever you put into your Sphinx packet messages as well as what your app's environment may leak.