Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Application Setup Guide: User Sign-up and Integration

Follow this step-by-step guide to sign up, set up your organization, and integrate essential tools like GitLab, Jira, and SonarQube to get your application up and running.

Part 1: Initial Setup (Hivel UI)

Step 1: Sign Up

  1. Go to http://localhost:3000/signup or http://<SERVER_IP>/signup

  2. Enter your email address and click Continue

  1. Create a password and click Sign up

  1. A verification email will be sent to your email address. Please check your inbox and complete the verification.

Step 2: Log In

  1. Navigate to the login page

  2. Enter your email and password

  3. You'll be redirected to the Company Profile Creation page

Step 3: Create Organization

  1. Fill in your organization's details and click Continue.

  1. Select approval method for new users and click Continue.

  1. You'll be directed to the Integration Page.

Part 2: Integration Setup (Hivel UI)

  • Choose which integrations to set up. Each integration below can be completed independently.

  • A few integrations are shown below. For the complete list of supported integrations, visit the Integrations page.

a. GitLab Integration

  1. On the Integration Page, click GitLab Connect

  2. Enter your GitLab details:

    • URL: Your GitLab domain (e.g., https://yourdomain.com)

    • Username: Name of the access token user

    • Email: Email associated with the access token user

    • Access Token: Your GitLab access token

    • API Version: /api/v4

  3. Wait approximately one minute for the integration to complete

  4. Verify in Hivel UI: Go to Settings > Repository

    • You'll see a progressively updated list of repositories being analyzed

b. Jira Integration

  1. On the Integration Page, click Jira Connect

  2. Enter your Jira details:

    • URL: Your Jira URL (For cloud: https://yourcompany.atlassian.net)

    • Username: Name of the access token user

    • Email: Email associated with the access token user

    • Access Token: Your Jira access token

    • API Version: /rest/api/3/

c. SonarQube Integration

  1. On the Integration Page, click SonarQube Connect

  2. Enter your SonarQube details:

    • SonarQube URL: Your SonarQube instance URL

    • Access Token: Your SonarQube access token

What to Expect After Setup

The initial data pull may take time depending on the volume of historical data being synchronized. Once integrations are complete, you can access the full functionality of Hivel.

For the complete list of supported integrations and detailed setup instructions, see the Integrations page.

🔗Integrations

Troubleshooting

For issues during setup, see Troubleshooting or contact support@hivel.ai.

Next Steps

Review these operational guides to prepare for ongoing management:

Verification and Access

Troubleshooting

Last updated