From 3d586d85bc1f9109920f5847081ef6620cbd0434 Mon Sep 17 00:00:00 2001 From: Moein Zargarzadeh Date: Sun, 7 Apr 2024 01:58:16 +0000 Subject: [PATCH] Due to $ sign in salted hash should be use single quotes! --- docs/guard/env-references.md | 2 +- docs/guard/setup.md | 2 +- docs/watcher/deploy-docker.md | 2 +- docs/watcher/env-references.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guard/env-references.md b/docs/guard/env-references.md index 0c9b82b..7c72836 100644 --- 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 index aacb05a..8ca5ee4 100644 --- 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 index a53781c..b2d266b 100644 --- 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 index be22f7b..b04827b 100644 --- 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