Skip to content

Commit

Permalink
Merge pull request #757 from oasisprotocol/amela/refresh-run-node
Browse files Browse the repository at this point in the history
docs/node: Refresh Run a node
  • Loading branch information
amela authored Mar 8, 2024
2 parents 8ab913c + 091898d commit 418fc1f
Showing 1 changed file with 31 additions and 25 deletions.
56 changes: 31 additions & 25 deletions docs/node/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,38 @@ import {findSidebarItem} from '@site/src/sidebarUtils';

# Run Node

The following documentation is intended to assist any individual or
organization in participating in the Oasis network as a node operator. To join
the network we recommend you first try running a node on the Testnet. The
Testnet is a playground where you can learn and experiment without the risk
of losing real tokens.
Welcome! This documentation is designed to provide you with a comprehensive
understanding and step-by-step guidance for becoming a node operator within the
Oasis Network.

Embark on your journey by setting up a node on the Testnet. The Testnet serves
as an experimental sandbox, offering a safe environment for learning and
experimentation, free from the risks associated with real token loss.

For any queries or support related to node operation, our team and community
members are readily available on [Discord] to assist you.

[Discord]: https://oasis.io/discord

## Validator and ParaTime nodes

[Oasis Network] consists of the consensus layer and ParaTimes. Consensus and
ParaTime nodes can be operated by anyone.

To run a **validator node**, make sure your system meets the [hardware] and the
[system] prerequisites and has [Oasis Node] installed.

Then proceed by following the [Run a Validator Node] guide to:

* Create your entity.
* Initialize and configure your node.
* Put enough stake in your escrow account.
* Register your entity on the network.

To run a **ParaTime node** make sure to first set up a validator node. Then,
set up a [trusted execution environment (TEE)], if you want to run confidential
ParaTimes. Afterwards, proceed to the [Run a ParaTime node] chapter.

:::info

Consensus layer is a decentralised set of 120 validator nodes that are a
Expand All @@ -31,27 +54,10 @@ node operator you can participate in any number of ParaTimes.

:::

If you have any questions about running a node you can find us on [Discord].

[Oasis Network]: ..//general/oasis-network/README.mdx
[Oasis Scan]: https://www.oasisscan.com/validators
[Discord]: https://oasis.io/discord

## Node Roles

To run a **Validator node**, make sure your system meets the [Hardware] and the
[System] prerequisites and has [Oasis Node] installed.

Then proceed by following the [Run a Validator Node] guide to:

* Create your entity.
* Initialize and configure your node.
* Put enough stake in your escrow account.
* Register your entity on the network.

To run a **ParaTime node** make sure to first set up a Validator node. Then,
set up a [trusted execution environment (TEE)], if you want to run confidential
ParaTimes. After that, proceed to the [Run a ParaTime node].
## DApp Developers

If you are **building a service** on top of the Oasis Network, you will simply
want to set up your own **[Non-validator node]** and (optionally) a
Expand All @@ -60,8 +66,8 @@ party endpoints which can be behind a traffic limiter, can go down unexpectedly,
or they can have some more CPU-intensive queries disabled which you would like
to use.

[Hardware]: ./run-your-node/prerequisites/hardware-recommendations.md
[System]: ./run-your-node/prerequisites/system-configuration.mdx
[hardware]: ./run-your-node/prerequisites/hardware-recommendations.md
[system]: ./run-your-node/prerequisites/system-configuration.mdx
[Oasis Node]: ./run-your-node/prerequisites/oasis-node.md
[Run a Validator Node]: ./run-your-node/validator-node.mdx
[trusted execution environment (TEE)]: ./run-your-node/prerequisites/set-up-trusted-execution-environment-tee.md
Expand Down

0 comments on commit 418fc1f

Please sign in to comment.