diff --git a/content/tutorials/connect-remote-gui.md b/content/tutorials/connect-remote-gui.md new file mode 100644 index 0000000..32de83d --- /dev/null +++ b/content/tutorials/connect-remote-gui.md @@ -0,0 +1,83 @@ +--- +title: Connect GUI to Remote Node +weight: 8 +--- + +Since Pactus version 1.12.0, users can connect to a remote node using the Pactus GUI. +This enables them to easily monitor their node on any VPS from their personal computer. +Managing your nodes, sending transactions, and monitoring validators can all be done through the GUI application. + +In this document, we explain the ways you can connect to your node through the Pactus GUI. + +## Bare Connection + +To connect to your node, the [gRPC](https://grpc.io/docs/what-is-grpc/) service of your remote node must be enabled. +The gRPC connection is unencrypted by default, so the connection between the GUI and your node is bare and unencrypted. + +Here is an example of how you can connect to your node: + +{{< os_tabs items="unix,windows" >}} + {{< os_tab >}} + +```shell +./pactus-gui -grpc-addr http://testnet1.pactus.org:50052 -grpc-insecure +``` + + {{< /os_tab >}} + {{< os_tab >}} + +```shell +pactus-gui.exe -grpc-addr http://testnet1.pactus.org:50052 -grpc-insecure +``` + + {{< /os_tab >}} +{{< /os_tabs >}} + +You can use an IP address for the connection, such as `157.180.70.236:50052`. +The `-grpc-insecure` flag indicates that the connection is not secure and not encrypted. +We do not recommend enabling the wallet service in this mode, as all credentials and +information you send or receive may be observed by a man-in-the-middle attacker. + +## Secure Connection + +One simple way to secure the gRPC connection is to wrap it over the `https` protocol. +This is known as [gRPC-Web](https://grpc.io/docs/platforms/web/). + +You can follow the [Secure Connections](./secure-connections.md) tutorial to set up your server to +wrap the gRPC connection over the `https` protocol. We have explained how to secure the connection there. +This approach requires a domain name and NGINX installed on your server. + +Once the gRPC-Web setup is complete, you can connect to your node in a secure and encrypted way, as shown below: + +{{< os_tabs items="unix,windows" >}} + {{< os_tab >}} + +```shell +./pactus-gui -grpc-addr https://testnet1.pactus.org/grpc-web +``` + + {{< /os_tab >}} + {{< os_tab >}} + +```shell +pactus-gui.exe -grpc-addr https://testnet1.pactus.org/grpc-web +``` + + {{< /os_tab >}} +{{< /os_tabs >}} + +In this case, your connection from your computer to your node is fully encrypted and secure against man-in-the-middle attacks. + +## Enabling Wallet Service + +By default, the wallet service on your node is disabled. You can enable it in the config file; +however, if your connection is insecure, we do not recommend it. +If you do enable it, make sure you set a strong password for your wallet. + +## FAQ + +### I got a `server: 403 (Forbidden)` error + +If you set up your domain using Cloudflare, this is most likely because the Cloudflare gRPC service is disabled. +You can check their [documentation](https://developers.cloudflare.com/network/grpc-connections/#enable-grpc) +to enable the gRPC service. diff --git a/content/tutorials/integration-guide.md b/content/tutorials/integration-guide.md index b308c6c..8191f7e 100644 --- a/content/tutorials/integration-guide.md +++ b/content/tutorials/integration-guide.md @@ -1,6 +1,6 @@ --- title: Pactus Integration Guide -weight: 13 +weight: 14 --- ## Preface diff --git a/content/tutorials/linux-systemd.md b/content/tutorials/linux-systemd.md index 0e8a162..3d2df29 100644 --- a/content/tutorials/linux-systemd.md +++ b/content/tutorials/linux-systemd.md @@ -1,6 +1,6 @@ --- title: Run Pactus with systemd on Linux -weight: 10 +weight: 11 --- ## Preface diff --git a/content/tutorials/pactus-metrics.md b/content/tutorials/pactus-metrics.md index ae5f1dd..0defa13 100644 --- a/content/tutorials/pactus-metrics.md +++ b/content/tutorials/pactus-metrics.md @@ -1,6 +1,6 @@ --- title: Run Pactus Metrics -weight: 9 +weight: 10 --- ## Preface diff --git a/content/tutorials/pactus-testnet.md b/content/tutorials/pactus-testnet.md index b87a5a2..1fdebf3 100644 --- a/content/tutorials/pactus-testnet.md +++ b/content/tutorials/pactus-testnet.md @@ -1,6 +1,6 @@ --- title: Join Pactus Testnet -weight: 14 +weight: 15 --- ## Preface diff --git a/content/tutorials/reduce-network.md b/content/tutorials/reduce-network.md index 5db8198..ca6f73d 100644 --- a/content/tutorials/reduce-network.md +++ b/content/tutorials/reduce-network.md @@ -1,6 +1,6 @@ --- title: Reduce Network Usage -weight: 8 +weight: 9 --- ## Preface diff --git a/content/tutorials/software-verification.md b/content/tutorials/software-verification.md index c924793..3644dac 100644 --- a/content/tutorials/software-verification.md +++ b/content/tutorials/software-verification.md @@ -1,6 +1,6 @@ --- title: Verify Pactus Software Is Safe -weight: 11 +weight: 12 --- ## Preface diff --git a/content/tutorials/zero-fee-transactions.md b/content/tutorials/zero-fee-transactions.md index c2b9cd2..fde7fcb 100644 --- a/content/tutorials/zero-fee-transactions.md +++ b/content/tutorials/zero-fee-transactions.md @@ -1,6 +1,6 @@ --- title: Send Zero-Fee Transactions -weight: 12 +weight: 13 --- ## Preface