Skip to content

Commit

Permalink
docs: Updated setup docs for GRAPHQL explanation and ARNS_ROOT_HOST
Browse files Browse the repository at this point in the history
Corrected explanation of GRAPHQL values in .env and added ARNS_ROOT_HOST with explanation. Also removed lines advising against using a subdomain for your node.
  • Loading branch information
Bobinstein authored and djwhitt committed Jul 19, 2023
1 parent 779e800 commit f8fc717
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
9 changes: 5 additions & 4 deletions docs/linux-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,16 @@ The following instructions will guide you through the process of installing the
```
nano .env
```
Paste the following content into the new file, save, and exit:
Paste the following content into the new file, replacing \<your-domain> with the domain address you are using to access the node, save, and exit:
```
GRAPHQL_HOST=arweave.net
GRAPHQL_PORT=443
START_HEIGHT=1000000
ARNS_ROOT_HOST=<your-domain>
```
- The GRAPHQL values set the proxy for GQL queries to arweave.net, You may use any available gateway that supports GQL queries. Your node can handle direct GQL queries, but only indexes L1 transactions by default and will fall back on your chosen proxy for any transactions not indexed.
- The GRAPHQL values set the proxy for GQL queries to arweave.net, You may use any available gateway that supports GQL queries. If omitted, your node can support GQL queries on locally indexed transactions, but only L1 transactions are indexed by default.
- `START_HEIGHT` is an optional line. It sets the block number where your node will start downloading and indexing transactions headers. Omitting this line will begin indexing at block 0.
- `ARNS_ROOT_HOST` sets the starting point for resolving ARNS names, which are accessed as a subdomain of a gateway. It should be set to the url you are pointing to your node, excluding any protocol prefix. For example, use `node-ar.io` and not `https://node-ar.io`. If you are using a subdomain to access your node and do not set this value, the node will not understand incoming requests.

- Build the Docker container:
```
Expand Down Expand Up @@ -126,10 +128,9 @@ The following guide assumes you are running your node on a local home computer.
- Register a Domain Name:
Choose a domain registrar (e.g., [Namecheap](https://www.namecheap.com)) to register a domain name.

- **Note**: The domain should be a base domain ("ardrive.io"), do not use a subdomain ("docs.ardrive.io").

- Point the Domain at Your Home Internet:
- Obtain your public IP address by visiting https://www.whatsmyip.org/ or running:

```
curl ifconfig.me
```
Expand Down
7 changes: 4 additions & 3 deletions docs/windows-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,16 @@ Before starting the installation process, ensure you have the following:
- Open a text editor (e.g., Notepad):
- Press `Windows Key` and search for "Notepad".
- Click on "Notepad" to open the text editor.
- Paste the following content into the new file:
- Paste the following content into the new file, replacing \<your-domain> with the domain address you are using to access the node:
```
GRAPHQL_HOST=arweave.net
GRAPHQL_PORT=443
START_HEIGHT=1000000
ARNS_ROOT_HOST=<your-domain>
```
- The GRAPHQL values set the proxy for GQL queries to arweave.net, You may use any available gateway that supports GQL queries. Your node can handle direct GQL queries, but only indexes L1 transactions by default and will fall back on your chosen proxy for any transactions not indexed.
- The GRAPHQL values set the proxy for GQL queries to arweave.net, You may use any available gateway that supports GQL queries. If omitted, your node can support GQL queries on locally indexed transactions, but only L1 transactions are indexed by default.
- `START_HEIGHT` is an optional line. It sets the block number where your node will start downloading and indexing transactions headers. Omitting this line will begin indexing at block 0.
- `ARNS_ROOT_HOST` sets the starting point for resolving ARNS names, which are accessed as a subdomain of a gateway. It should be set to the url you are pointing to your node, excluding any protocol prefix. For example, use `node-ar.io` and not `https://node-ar.io`. If you are using a subdomain to access your node and do not set this value, the node will not understand incoming requests.
- Save the file with the name ".env" and make sure to select "All Files" as the file type. This helps to ensure the file saves as ".env" and not ".env.txt"

**Note**: The `.env` file should be saved inside the same directory where you cloned the repository (e.g., `ar-io-node`).
Expand Down Expand Up @@ -115,7 +117,6 @@ To expose your node to the internet and use a custom domain, follow these steps:

1. Obtain a Domain Name:
- Choose a domain registrar (e.g., [Namecheap](https://www.namecheap.com)) and purchase a domain name.
- **Note**: The domain should be a base domain ("ardrive.io"), do not use a subdomain ("docs.ardrive.io").

2. Point the Domain at Your Home Network:
- In your browser, go to https://www.whatsmyip.org/ to display your public ip address. It can be found at the top of the screen. Note this number down.
Expand Down

0 comments on commit f8fc717

Please sign in to comment.