Skip to content

Commit

Permalink
fix: update README table of contents and formatting (#653)
Browse files Browse the repository at this point in the history
  • Loading branch information
justinthelaw authored Jun 18, 2024
1 parent 37badae commit cd7e2a6
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
- [UDS (Dev)](#uds-dev)
- [CPU](#cpu)
- [GPU](#gpu)
- [Accessing the UI](#accessing-the-ui)
- [Cleanup](#cleanup)
- [Local Dev](#local-dev)
- [API](#api-1)
- [Repeater](#repeater-1)
Expand Down Expand Up @@ -50,7 +52,7 @@ Large Language Models (LLMs) are a powerful resource for AI-driven decision maki

The LeapfrogAI repository follows a monorepo structure based around an [API](#api) with each of the [components](#components) included in a dedicated `packages` directory. Each of these package directories contains the source code for each component as well as the deployment infrastructure. The UDS bundles that handle the development and latest deployments of LeapfrogAI are in the `uds-bundles` directory. The structure looks as follows:

```
```shell
leapfrogai/
├── src/
│ ├── leapfrogai_api/
Expand Down Expand Up @@ -179,25 +181,32 @@ uds deploy uds-bundle-leapfrogai-*.tar.zst --confirm
LeapfrogAI is integrated with the UDS Core KeyCloak service, which provides authentication via SSO. Below are general instructions for accessing the LeapfrogAI UI after a successful UDS deployment of UDS Core and LeapfrogAI.

1. Connect to the KeyCloak admin panel
a. Run the following to get a port-forwarded tunnel: `uds zarf connect keycloak`
b. Go to the resulting localhost URL and create an admin account
- Run the following to get a port-forwarded tunnel: `uds zarf connect keycloak`
- Go to the resulting localhost URL and create an admin account

2. Go to ai.uds.dev and press "Login using SSO"

3. Register a new user by pressing "Register Here"

4. Fill-in all of the information
a. The bot detection requires you to scroll and click around in a natural way, so if the Register button is not activated despite correct information, try moving around the page until the bot detection says 100% verified
- The bot detection requires you to scroll and click around in a natural way, so if the Register button is not activated despite correct information, try moving around the page until the bot detection says 100% verified

5. Using an authenticator, follow the MFA steps

6. Go to sso.uds.dev
a. Login using the admin account you created earlier
- Login using the admin account you created earlier

7. Approve the newly registered user
a. Click on the hamburger menu in the top left to open/close the sidebar
b. Go to the dropdown that likely says "Keycloak" and switch to the "uds" context
c. Click "Users" in the sidebar
d. Click on the newly registered user's username
e. Go to the "Email Verified" switch and toggle it to be "Yes"
f. Scroll to the bottom and press "Save"
- Click on the hamburger menu in the top left to open/close the sidebar
- Go to the dropdown that likely says "Keycloak" and switch to the "uds" context
- Click "Users" in the sidebar
- Click on the newly registered user's username
- Go to the "Email Verified" switch and toggle it to be "Yes"
- Scroll to the bottom and press "Save"

8. Go back to ai.uds.dev and login as the registered user to access the UI

### Clean-up
### Cleanup

To clean-up or perform a fresh install, run the following commands in the context in which you had previously installed UDS Core and LeapfrogAI:

Expand Down

0 comments on commit cd7e2a6

Please sign in to comment.