add fast init doc (#220)

decentralized-identity · Jul 21, 2021 · 56643ca · 56643ca
1 parent c91096f
commit 56643ca
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/install-guide.md b/install-guide.md
@@ -185,7 +185,8 @@ Update the ION Bitcoin microservice (e.g. `/etc/ion/testnet-bitcoin-config.json`
      - testnet: `http://localhost:18332`
      - mainnet: `http://localhost:8332` (assuming default Bitcoin Core configuration from Step 2)
   - `bitcoinDataDirectory`
-    - It needs to point to the block files folder:
+    - This is an ***optional*** config value. By configuring this value, instead of using rpc call to initialize Bitcoin microservice, the node will read from the block binary files. This is useful in speeding up init time if you have fast access to the files (local SSD is optimal). If the files are stored and retireved across network, such as on the cloud in AWS S3 Bucket or Azure Blob Storage, then this will be slower than using RPC as it has to download GB worth of files.
+    - Leave it blank if you do not wish to init from file. If you want to init from files, it needs to point to the block files folder:
      - testnet: `[datadir]/testnet3`.
      - mainnet: exactly the same as the `[datadir]` value configured for Bitcoin Core in Step 2.
   - `bitcoinWalletImportString`