From 81ca82e9b34e241771b2ba98a63515ef6c0b0244 Mon Sep 17 00:00:00 2001 From: Moein Zargarzadeh Date: Fri, 5 Apr 2024 23:46:17 +0000 Subject: [PATCH] Update doc for saltedHash --- docs/guard/setup.md | 2 +- docs/watcher/deploy-docker.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guard/setup.md b/docs/guard/setup.md index 811695d..aacb05a 100644 --- a/docs/guard/setup.md +++ b/docs/guard/setup.md @@ -42,7 +42,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 Blake2b hash of `hello` is `324dcf027dd4a30a932c441f365a25e86b173defa4b8e58948253471b81b72cf`. +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. diff --git a/docs/watcher/deploy-docker.md b/docs/watcher/deploy-docker.md index 8e80aaf..a53781c 100644 --- a/docs/watcher/deploy-docker.md +++ b/docs/watcher/deploy-docker.md @@ -94,7 +94,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 Blake2b hash of `hello` is `324dcf027dd4a30a932c441f365a25e86b173defa4b8e58948253471b81b72cf`. +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.