Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add authentication instructions #75

Merged
merged 1 commit into from
Oct 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
- [email protected]
- [email protected]
```

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

Expand Down