Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Node/Relayminer/AppgateServer deployment guide #400

Merged
merged 17 commits into from
Apr 5, 2024
Merged
118,061 changes: 98,365 additions & 19,696 deletions docs/static/openapi.yml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docusaurus/docs/developer_guide/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Install the following dependencies:
6. [Tilt](https://docs.tilt.dev/install.html) - k8s local development tool & environment manager

:::note
You might already have these installed if you've followed the [localnet instructions](../infrastructure/localnet.md).
You might already have these installed if you've followed the [localnet instructions](./internal_infrastructure/localnet.md).
Olshansk marked this conversation as resolved.
Show resolved Hide resolved
:::

## Launch LocalNet
Expand Down
8 changes: 0 additions & 8 deletions docusaurus/docs/infrastructure/_category_.json

This file was deleted.

8 changes: 8 additions & 0 deletions docusaurus/docs/internal_infrastructure/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Internal infrastructure",
"position": 10,
"link": {
"type": "generated-index",
"description": "Documentation for internal Pocket network team infrastructure: LocalNet, DevNet and TestNets."
}
}
8 changes: 8 additions & 0 deletions docusaurus/docs/run_a_node/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Run a Node",
"position": 8,
"link": {
"type": "generated-index",
"description": "Guides and documentation on how to run Pocket Network software"
}
}
16 changes: 16 additions & 0 deletions docusaurus/docs/run_a_node/appgate_server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
**AppGate Server - Docker Compose**

- [What is AppGate Server](#what-is-appgate-server)
- [Docker Compose Example Repository](#docker-compose-example-repository)

### What is AppGate Server

An AppGate Server plays a crucial role within the Pocket Network ecosystem, serving as a bridge between decentralized applications (dApps), such as mobile or web applications, and the Suppliers operating on the Pocket Network. Its primary function is to handle the necessary intermediary logic and facilitate seamless communication and transactions.

If you're a Node Runner interested in deploying a [Gateway](../actors/gateway.md) or a sovereign [Application](../actors/application.md) that requires direct access to Pocket Network functionalities, setting up an AppGate Server is highly recommended.

### Docker Compose Example Repository

To simplify the process of deploying an AppGate Server, we have created an illustrative example utilizing Docker Compose. This example is hosted in the [poktroll-docker-compose-example](https://github.com/pokt-network/poktroll-docker-compose-example?tab=readme-ov-file#deploying-an-appgate-server) GitHub repository.

Please refer to the "Deploying an AppGate Server" section within the repository for detailed instructions and guidance on setting up your AppGate Server using the provided Docker Compose example.
18 changes: 18 additions & 0 deletions docusaurus/docs/run_a_node/full_node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
**Full Node - Docker Compose**

- [What is a Full Node](#what-is-a-full-node)
- [Docker Compose Example Repository](#docker-compose-example-repository)

### What is a Full Node

In a blockchain network, a Full Node retains a complete copy of the ledger, verifying all transactions and blocks according to the network's rules. While it does not play a role in block creation or consensus, it is crucial for ensuring data integrity, enhancing network security, and fostering decentralization. Full Nodes facilitate this by distributing transactions and blocks to other nodes.

Within the Pocket Network ecosystem, the role of Full Nodes is pivotal for Node Runners. These nodes are essential for off-chain entities like RelayMiners and AppGates, which rely on interaction with the Pocket Network blockchain for optimal functionality.

This guide outlines the setup process for a Full Node using Docker Compose, offering a simplified and efficient method for launching a Full Node.

### Docker Compose Example Repository

To help you understand how a Full Node can be operated with Docker Compose, we have prepared an example in the [poktroll-docker-compose-example](https://github.com/pokt-network/poktroll-docker-compose-example) GitHub repository.

Please refer to the "Deploying a Full Node" section of the guide in that repository for detailed instructions on setting up your Full Node using the provided Docker Compose example.
14 changes: 14 additions & 0 deletions docusaurus/docs/run_a_node/relay_miner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**RelayMiner - Docker Compose**

- [What is a RelayMiner](#what-is-a-relayminer)
- [Docker Compose Example Repository](#docker-compose-example-repository)

### What is a RelayMiner

A RelayMiner is a specialized node designed for individuals to offer services through the Pocket Network. For more information on this role, please refer to the [RelayMiner documentation](../actors/relay_miner.md). Unlike the Pocket Morse Mainnet client, which supports service provision on the current Pocket Network Mainnet and maintains a copy of the blockchain data, the RelayMiner operates without storing blockchain data. Instead, it relies on connections to Full Nodes for interacting with the blockchain. It is crucial to deploy a [Full Node](full_node.md) prior to setting up a RelayMiner, as this ensures the necessary infrastructure for blockchain communication is in place.

### Docker Compose Example Repository

To help you get started with deploying a RelayMiner, we have prepared an example using Docker Compose. This example is available in the [poktroll-docker-compose-example](https://github.com/pokt-network/poktroll-docker-compose-example?tab=readme-ov-file#deploying-a-relay-miner) GitHub repository.

Please refer to the "Deploying a RelayMiner" section within the repository for detailed instructions and guidance on setting up your RelayMiner using the provided Docker Compose example.
Loading
Loading