Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-Authored-By: Lucas Bertrand <lucas.bertrand.22@gmail.com>
Co-Authored-By: Benjamin LEVESQUE <14175665+benjlevesque@users.noreply.github.com>
  • Loading branch information
3 people committed Mar 11, 2020
1 parent 9217a91 commit 7362bd7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
17 changes: 8 additions & 9 deletions packages/docs/docs/guides/6-hosting-a-node/0-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,40 @@ In this guide we will explain what is the Request Node and help you to run your

## What is the Request Node?

Request Nodes are servers that run the lower layers of the Request protocol. They connect to the Ethereum and IPFS networks, to store and retrieve request transactions. Protocol users can interact with the Request Node through HTTP using the [request-client.js](../5-request-client/0-intro) library.
Request Nodes are servers that run the lower layers of the Request Protocol. They connect to the Ethereum and IPFS networks, to store and retrieve request transactions. Protocol users can interact with the Request Node through HTTP using the [request-client.js](../5-request-client/0-intro) library.

## Why run your own Node?

Running the Node locally on your machine will allow you to test your code using the Request Client easilly.

You may also want to host your Node in a server. Hosting your Node is the most decentralized setup possible. It allows you to:

- Store your own data and make sure it is safelly backed up
- Store your own data and make sure it is safely backed up
- Be technically independent: own your servers and control how you manage them
- Use custom configuration settings
- Customize storage options

## How to run your Node?

There are 3 currently supported ways to run the Request Node:
There are currently three supported ways to run a Request Node:

- Run from [**Docker**](./1-docker). Probably the easiest way to run the Request Node.
- Run from [**Docker**](./1-docker). The easiest way to run the Request Node.
- Run the [**code**](./2-code) from the git repository. Especially useful if you are making changes to the protocol layers.
- Use our kubernetes **helm** charts. The best solution if you want to host your node on a Kubernetes cluster.

On the next pages, you can find out detailed steps on how to run each one of these.

## Prerequisites

Request uses IPFS and Ethereum as the storage for our protocol data. For this reason the Node needs connections to an Ethereum node and an IPFS node.
Request uses IPFS and Ethereum to store request transactions. For this reason the Node needs connections to an Ethereum node and an IPFS node.

### Ethereum node

You can use any HTTP/S Ethereum node to run your Request Node.
For local development, you can use ganache (explained in more details on the following pages).
For local development, you can use ganache-cli, a local Ethereum RPC client for tests (explained in more details on the following pages).

An easy way to get going with Ethereum Mainnet or Rinkeby is to use services like infura, that will expose an Ethereum Node API for you.
An easy way to get going with Ethereum Mainnet or Rinkeby is to use services like Infura, that will expose an Ethereum Node API for you.

### IPFS Node

Request uses a dedicated IPFS network. This means that you need to have an IPFS Node with our network settings connected to your Request Node.
The good news is it's easy to set up our IPFS and we will show it to you on our next steps.
The good news is it's easy to set up our IPFS Node and we will show it to you on our next steps.
4 changes: 2 additions & 2 deletions packages/docs/docs/guides/6-hosting-a-node/2-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ cd packages/smart-contracts
yarn ganache
```

Now you have ganache running on your second console.
We're still missing all the important smart-contracts request use. On a new console, run:
Now you have ganache-cli running on your second console.
We're still missing all the important smart-contracts that Request uses. On a new console, run:

```bash
cd packages/smart-contracts
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/docs/guides/6-hosting-a-node/3-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Deploying a node in Kubernetes with Helm
keywords: [Request node, helm, kubernetes]
---

Deploying a Request node on Kubernetes is straightforward using our [helm](https://helm.sh/) chart.
Deploying a Request Node on Kubernetes is straightforward using our [helm](https://helm.sh/) chart.

You can see our chart in our [git repository](https://github.com/RequestNetwork/request-helm-charts/tree/master/request-node).

Expand Down

0 comments on commit 7362bd7

Please sign in to comment.