GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

finish exit gateway setup

Browse Source
This commit is contained in:
serinko
2023-11-01 12:00:16 +01:00
parent 07037341c5
commit 73fe7ebec7
1 changed files with 29 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/operators/src/nodes/gateway-setup.md
+29 -18
View File
@@ -65,7 +65,7 @@ There has been an ongoing development with dynamic upgrades. Follow the status o
An operator can initialise the Exit Gateway functionality by adding Network requester with the new exit policy option:
```
./nym-gateway init --id <ID> --host $(curl -4 https://ifconfig.me) --with-network-requester --with-exit-policy
./nym-gateway init --id <ID> --host $(curl -4 https://ifconfig.me) --with-network-requester --with-exit-policy true
```
If we follow the previous example with `<ID>` chosen `superexitgateway`, adding the `--with-network-requester` and `--with-exit-policy` flags, the outcome will be:
@@ -76,13 +76,13 @@ If we follow the previous example with `<ID>` chosen `superexitgateway`, adding
```
~~~
You can see that the printed information besides *identity* and *sphinx keys* also includes a long string called *address*. This is the address to be provided to your local [socks5 client](https://nymtech.net/docs/clients/socks5-client.html) as a `--provider` if you wish to connect to your own exit gateway.
You can see that the printed information besides *identity* and *sphinx keys* also includes a long string called *address*. This is the address to be provided to your local [socks5 client](https://nymtech.net/docs/clients/socks5-client.html) as a `--provider` if you wish to connect to your own Exit Gateway.
Additionally
#### Add Network requester to existing Gateway
#### Add Network requester to an existing Gateway
If you already run a gateway and got it [upgraded](./maintenance.md#upgrading-your-node) to the [newest version](./gateway-setup.md#current-version), you can easily change its functionality to exit gateway. Pause the gateway and run a command `setup-network-requester`.
If you already [upgraded](./maintenance.md#upgrading-your-node) your Gateway to the [newest version](./gateway-setup.md#current-version) and initialised without a Network requester, you can easily change its functionality to Exit Gateway with a command `setup-network-requester`.
See the options:
@@ -96,19 +96,28 @@ See the options:
```
~~~
Run with `--enabled true` flag choosing `<ID>` as `supergateway`:
To setup Exit Gateway functionality with our new [exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt) add a flag `--with-exit-policy true`.
```
./nym-gateway setup-network-requester --enabled true --id supergateway
./nym-gateway setup-network-requester --enabled true --with-exit-policy true --id <ID>
```
Example choosing `<ID>` as `exit-gateway`:
```
./nym-gateway setup-network-requester --enabled true --with-exit-policy true --id exit-gateway
```
(In the following output we first initialised the Gateway without the functionality and then ran the command above.)
~~~admonish example collapsible=true title="Console output"
```
<!-- cmdrun ../../../../target/release/nym-gateway setup-network-requester --enabled true --id supergateway -->
<!-- cmdrun ../../../../target/release/nym-gateway setup-network-requester --enabled true --id exit-gateway -->
<!-- cmdrun ../../../../target/release/nym-gateway setup-network-requester --enabled true --id exit-gateway -->
```
~~~
In case there are any problems, you can also change it manually by editing the gateway config stored in `/home/user/.nym/gateways/<ID>/config/config.toml` where the line under `[network_requester]` needs to be edited from `false` to `true`.
In case there are any unexpected problems, you can also change it manually by editing the Gateway config stored in `/home/user/.nym/gateways/<ID>/config/config.toml` where the line under `[network_requester]` needs to be edited from `false` to `true`.
```
[network_requester]
@@ -116,17 +125,15 @@ In case there are any problems, you can also change it manually by editing the g
enabled = true
```
Save, exit and restart your gateway. Now it is a post-smooshed exit gateway.
Save, exit and restart your gateway. Now you are an operator of post-smooshed Exit gateway.
All information about network requester part of your exit gateway is in `/home/user/.nym/gateways/snus/config/network_requester_config.toml`.
For now you can run Gateway without Network requester or with and without the new exit policy. This will soon change as we inform in our [Project Smoosh FAQ](../faq/smoosh-faq.html#how-will-the-exit-policy-be-implemented).
To read more about the configuration like whitelisted outbound requesters in `allowed.list` and other useful information, see the page [*Network Requester Whitelist*](network-requester-setup.md#using-your-network-requester).
```admonish info
Before you bond and run your gateway, please make sure the [firewall configuration](./maintenance.md#configure-your-firewall) is setup so your gateway can be reached from the outside.
```
#### Initialising Gateway without Network requester
In case you don't want to run your Gateway with the Exit Gateway functionality, you still can run a simple Gateway.
@@ -143,15 +150,15 @@ To check available configuration options use:
```
~~~
The following command returns a gateway on your current IP with the `<ID>` of `supergateway`:
The following command returns a gateway on your current IP with the `<ID>` of `simple-gateway`:
```
./nym-gateway init --id supergateway --host $(curl -4 https://ifconfig.me)
./nym-gateway init --id simple-gateway --host $(curl -4 https://ifconfig.me)
```
~~~admonish example collapsible=true title="Console output"
```
<!-- cmdrun ../../../../target/release/nym-gateway init --id supergateway --host $(curl -4 https://ifconfig.me) -->
<!-- cmdrun ../../../../target/release/nym-gateway init --id simple-gateway --host $(curl -4 https://ifconfig.me) -->
```
~~~
@@ -160,6 +167,10 @@ The `$(curl -4 https://ifconfig.me)` command above returns your IP automatically
### Bonding your gateway
```admonish info
Before you bond and run your Gateway, please make sure the [firewall configuration](./maintenance.md#configure-your-firewall) is setup so your gateway can be reached from the outside.
```
#### Via the Desktop wallet
You can bond your gateway via the Desktop wallet.
@@ -187,7 +198,7 @@ It will look something like this:
|_| |_|\__, |_| |_| |_|
|___/
(nym-gateway - version v1.1.29)
(nym-gateway - version v1.1.31)
>>> attempting to sign 2Mf8xYytgEeyJke9LA7TjhHoGQWNBEfgHZtTyy2krFJfGHSiqy7FLgTnauSkQepCZTqKN5Yfi34JQCuog9k6FGA2EjsdpNGAWHZiuUGDipyJ6UksNKRxnFKhYW7ri4MRduyZwbR98y5fQMLAwHne1Tjm9cXYCn8McfigNt77WAYwBk5bRRKmC34BJMmWcAxphcLES2v9RdSR68tkHSpy2C8STfdmAQs3tZg8bJS5Qa8pQdqx14TnfQAPLk3QYCynfUJvgcQTrg29aqCasceGRpKdQ3Tbn81MLXAGAs7JLBbiMEAhCezAr2kEN8kET1q54zXtKz6znTPgeTZoSbP8rzf4k2JKHZYWrHYF9JriXepuZTnyxAKAxvGFPBk8Z6KAQi33NRQkwd7MPyttatHna6kG9x7knffV6ebGzgRBf7NV27LurH8x4L1uUXwm1v1UYCA1WSBQ9Pp2JW69k5v5v7G9gBy8RUcZnMbeL26Qqb8WkuGcmuHhaFfoqSfV7PRHPpPT4M8uRqUyR4bjUtSJJM1yh6QSeZk9BEazzoJqPeYeGoiFDZ3LMj2jesbJweQR4caaYuRczK92UGSSqu9zBKmE45a
@@ -209,7 +220,7 @@ It will look something like this:
* Your gateway is now bonded.
> You are asked to `sign` a transaction on bonding so that the mixnet smart contract is able to map your nym address to your node. This allows us to create a nonce for each account and defend against replay attacks.
> You are asked to `sign` a transaction on bonding so that the Mixnet smart contract is able to map your Nym address to your node. This allows us to create a nonce for each account and defend against replay attacks.
#### Via the CLI (power users)
If you want to bond your mix node via the CLI, then check out the [relevant section in the Nym CLI](https://nymtech.net/docs/tools/nym-cli.html#bond-a-mix-node) docs.