Merge branch 'update-doc-apiKey' into 'dev'

Due to $ sign in salted hash should be use single quotes! See merge request ergo/rosen-bridge/operation!25
rosen-bridge · Apr 7, 2024 · 2d7d629 · 2d7d629
2 parents ffc7d17 + 3d586d8
commit 2d7d629
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/guard/env-references.md b/docs/guard/env-references.md
@@ -18,7 +18,7 @@ POSTGRES_PORT=5432 # 5432 is set as default, you can change it.
 
 # Optional Environments
 ```
-API_KEY_HASH= # blake2b hash of api_key, e.g. API_KEY_HASH=myHashHere
+API_KEY_HASH= # blake2b saletd hash of api_key, please put your apiKeyHash between single quotes e.g. API_KEY_HASH='myHashHere'
 
 MNEMONIC= # ergo mnemonic phrases, e.g. MNEMONIC=word1 word2 word3 ... wordn
 

diff --git a/docs/guard/setup.md b/docs/guard/setup.md
@@ -44,7 +44,7 @@ Use [rosen command line](https://github.com/rosen-bridge/utils/tree/dev/packages
 #### Update Configuration File
 After obtaining the hash, input it into your config file. For example, the salted Blake2b hash of `hello` is `$USHxmI8E$7Bby9L7leeExrYFt2n3270K4+PMCCszZ+UwCV8klqBs=`.
 
-> **⚠️ NOTE**: When using docker there is an `API_KEY_HASH` environment variable available for `apiKeyHash` that you can set instead of in the local configuration. See your `.env` file. We recommend utilizing environment variables over direct configuration file settings for **security** purpose to not accidently share your api key while troubleshooting etc. After updating, you can delete `apiKeyHash` from /config/local.yaml.
+> **⚠️ NOTE**: When using docker there is an `API_KEY_HASH` environment variable available for `apiKeyHash` that you can set instead of in the local configuration. See your `.env` file. We recommend utilizing environment variables over direct configuration file settings for **security** purpose to not accidently share your api key while troubleshooting etc. After updating, you can delete `apiKeyHash` from /config/local.yaml. Note that you should set your hash between single quotes, for example: API_KEY_HASH='$USHxmI8E$7Bby9L7leeExrYFt2n3270K4+PMCCszZ+UwCV8klqBs='.
 
 ## DATABASE
 Specify your database connection and credentials.

diff --git a/docs/watcher/deploy-docker.md b/docs/watcher/deploy-docker.md
@@ -96,7 +96,7 @@ Use [rosen command line](https://github.com/rosen-bridge/utils/tree/dev/packages
 #### Update Configuration File
 After obtaining the hash, input it into your config file. For example, the salted Blake2b hash of `hello` is `$USHxmI8E$7Bby9L7leeExrYFt2n3270K4+PMCCszZ+UwCV8klqBs=`.
 
-> **⚠️ NOTE**: When using docker there is an `API_KEY_HASH` environment variable available for `apiKeyHash` that you can set instead of in the local configuration. See your `.env` file. We recommend utilizing environment variables over direct configuration file settings for **security** purpose to not accidently share your api key while troubleshooting etc. After updating, you can delete `apiKeyHash` from /config/local.yaml.
+> **⚠️ NOTE**: When using docker there is an `API_KEY_HASH` environment variable available for `apiKeyHash` that you can set instead of in the local configuration. See your `.env` file. We recommend utilizing environment variables over direct configuration file settings for **security** purpose to not accidently share your api key while troubleshooting etc. After updating, you can delete `apiKeyHash` from /config/local.yaml. Note that you should set your hash between single quotes, for example: API_KEY_HASH='$USHxmI8E$7Bby9L7leeExrYFt2n3270K4+PMCCszZ+UwCV8klqBs='.
 
 
 

diff --git a/docs/watcher/env-references.md b/docs/watcher/env-references.md
@@ -18,7 +18,7 @@ POSTGRES_PORT=5432 # 5432 is set as default, you can change it.
 
 # Optional Environments
 ```
-API_KEY_HASH= # blake2b hash of api_key, e.g. API_KEY_HASH=myHashHere
+API_KEY_HASH= # blake2b saletd hash of api_key, please put your apiKeyHash between single quotes e.g. API_KEY_HASH='myHashHere'
 
 MNEMONIC= # watcher mnemonic phrases, e.g. MNEMONIC=word1 word2 word3 ... wordn