docs: correct description of SKIP_CACHE

Setting SKIP_CACHE to 'true' instructs the node to skip the local cache and always fetch headers from the Arweave node.
ar-io · Sep 25, 2023 · 38210b9 · 38210b9
1 parent eb843a7
commit 38210b9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/.env.example b/.env.example
@@ -13,7 +13,7 @@
 # ArNS gateway
 # TRUSTED_ARNS_GATEWAY_URL="https://__NAME__.arweave.dev"
 
-# If true, use indexed data as a cache and skip fetching data from the node
+# If true, skips the local cache and always fetches headers from the node
 # SKIP_CACHE=false
 
 # Adds an "INSTANCE_ID" field to output logs

diff --git a/docs/envs.md b/docs/envs.md
@@ -10,7 +10,7 @@ This document describes the environment variables that can be used to configure
 | TRUSTED_ARNS_GATEWAY_URL       | String               | "https://__NAME__.arweave.dev" | ArNS gateway                                                                                                                    |
 | INSTANCE_ID                    | String               | ""                             | Adds an "INSTACE_ID" field to output logs                                                                                       |
 | LOG_FORMAT                     | String               | "simple"                       | Sets the format of output logs, accepts "simple" and "json"                                                                     |
-| SKIP_CACHE                     | Boolean              | false                          | If true, use indexed data as a cache and skip fetching data from the node                                                       |
+| SKIP_CACHE                     | Boolean              | false                          | If true, skips the local cache and always fetches headers from the node                                                         |
 | PORT                           | Number               | 4000                           | AR.IO node exposed port number                                                                                                  |
 | SIMULATED_REQUEST_FAILURE_RATE | Number               | 0                              | Number from 0 to 1, representing the probability of a request failing                                                           |
 | AR_IO_WALLET                   | String               | ""                             | Arweave wallet address used for staking and rewards                                                                             |