From 4c920041f7f8c5a651fe9ee50c85642f93215566 Mon Sep 17 00:00:00 2001
From: david-hummingbot <85695272+david-hummingbot@users.noreply.github.com>
Date: Sun, 8 Oct 2023 19:32:09 +0800
Subject: [PATCH] add authentication instructions

---
 INSTALLATION.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)

diff --git a/INSTALLATION.md b/INSTALLATION.md
index 48da1511..0917d9c4 100644
--- a/INSTALLATION.md
+++ b/INSTALLATION.md
@@ -33,6 +33,76 @@ conda activate dashboard
 ```bash
 streamlit run main.py
 ```
+## Configure Credentials for Authentication
+
+### Method 1: Using hasher_generate
+
+1 - Update the Environment
+  
+    Ensure that you have the latest version of the project and reinstall the conda environment if needed.
+  
+2 - Generate Hashed Password
+  
+    Open a Python terminal and utilize hasher_generate from Streamlit to generate a hashed password. Example code:
+
+    ```
+    import streamlit_authenticator as st_auth
+    hashed_password = st_auth.hasher_generate("YOUR_PLAIN_TEXT_PASSWORD")
+
+    ```
+
+3 - Edit the Credentials YAML File
+
+    Locate the credentials YAML file in the root directory.
+    Edit the file by inserting the generated hashed password from Step 2.
+
+4 - Accessing the Dashboard
+    
+    Run the Hummingbot Dashboard project.
+    Use the username and the plain text password (used in Step 2) to log in to the dashboard.
+
+5 - Logging Out
+    
+    To log out, navigate to the dashboard and select 'Logout'.
+    
+
+### Method 2: Using Pre-Authorized Emails for User Registration
+
+1 - Update the Environment
+
+    As in Method 1, ensure your conda environment and project version are up-to-date.
+
+2 - Whitelist Emails
+
+    In the credentials YAML file, add the emails of users who will be pre-authorized to register and create their credentials.
+
+    ```
+    pre_authorized_emails:
+      - user1@example.com
+      - user2@example.com
+    ```
+
+3 - User Registration
+
+    Direct users to the Hummingbot Dashboard.
+    Users should select 'Register' and enter one of the pre-authorized email addresses.
+    They will choose their own username and password during registration.
+    
+4 - First-Time Login
+    
+    Users log in with their chosen username and password.
+    The dashboard will hash and store their credentials automatically.
+
+5 - Logging Out
+    
+    Similar to Method 1, users can log out by navigating to the dashboard and selecting 'Logout'.
+
+### Additional Notes
+
+- Video instruction link - https://drive.google.com/file/d/17ecd2aWHZCyuK5Etcv8AZwXMw2B-1sJG/view?usp=share_link
+- Users created through Method 2 (Pre-Authorized Emails) will have their hashed passwords automatically generated and stored.
+- Always ensure the secure handling and storage of credentials.
+- Utilize the 'Logout' feature to secure information and restrict access to the dashboard when it is not in use.
 
 ## Updating