|
59 | 59 | <a href="#5-setting-up-ai-architect-mcp-in-coding-agents">Setting up AI Architect MCP in coding agents</a> |
60 | 60 | </li> |
61 | 61 | <li> |
62 | | - <a href="#6-configuring-ai-architect-for-bito-ai-code-review-agent">Configuring AI Architect for Bito AI Code Review Agent</a> |
| 62 | + <a href="#6-sso-authentication">SSO Authentication</a> |
63 | 63 | </li> |
64 | 64 | <li> |
65 | | - <a href="#7-command-reference">Command reference</a> |
| 65 | + <a href="#7-configuring-ai-architect-for-bito-ai-code-review-agent">Configuring AI Architect for Bito AI Code Review Agent</a> |
66 | 66 | </li> |
67 | 67 | <li> |
68 | | - <a href="#8-troubleshooting-guide">Troubleshooting guide</a> |
| 68 | + <a href="#8-command-reference">Command reference</a> |
69 | 69 | </li> |
70 | 70 | <li> |
71 | | - <a href="#9-upgrading-ai-architect">Upgrading AI Architect</a> |
| 71 | + <a href="#9-troubleshooting-guide">Troubleshooting guide</a> |
72 | 72 | </li> |
73 | 73 | <li> |
74 | | - <a href="#10-support--contact">Support & contact</a> |
| 74 | + <a href="#10-upgrading-ai-architect">Upgrading AI Architect</a> |
| 75 | + </li> |
| 76 | + <li> |
| 77 | + <a href="#11-support--contact">Support & contact</a> |
75 | 78 | </li> |
76 | 79 | </ol> |
77 | 80 | </details> |
|
82 | 85 |
|
83 | 86 | ## 1. Overview |
84 | 87 |
|
85 | | -Bito’s **[AI Architect](https://bito.ai/product/ai-architect/)** builds a knowledge graph of your codebase — from repos to modules to APIs — delivering deep codebase intelligence to the coding agents you already use. This fundamentally changes the game for enterprises with many microservices or large, complex codebases. |
| 88 | +Bito's **[AI Architect](https://bito.ai/product/ai-architect/)** builds a knowledge graph of your codebase — from repos to modules to APIs — delivering deep codebase intelligence to the coding agents you already use. This fundamentally changes the game for enterprises with many microservices or large, complex codebases. |
86 | 89 |
|
87 | 90 | Bito provides this in a completely secure fashion, with the AI Architect available on-prem if you desire, and no AI is trained on your code. |
88 | 91 |
|
@@ -139,7 +142,7 @@ Before you start the AI Architect setup in your environment, make sure you have |
139 | 142 | Required for personal use of AI Architect. Supports **Anthropic (Claude)** and **Grok** models. Add both keys for the best cost and coverage. AI Architect also supports **[Portkey](https://portkey.ai)** integration for custom proxy configurations. |
140 | 143 |
|
141 | 144 | ### **Bito Access Key** |
142 | | -You’ll need a **Bito account** and a **Bito Access Key** to authenticate AI Architect. You can sign up for a Bito account at https://alpha.bito.ai, and create an access key from Settings -> Advanced Settings **[Link](https://alpha.bito.ai/home/advanced)**. |
| 145 | +You'll need a **Bito account** and a **Bito Access Key** to authenticate AI Architect. You can sign up for a Bito account at https://alpha.bito.ai, and create an access key from Settings -> Advanced Settings **[Link](https://alpha.bito.ai/home/advanced)**. |
143 | 146 |
|
144 | 147 | ### **Git Access Token** |
145 | 148 | Used by AI Architect to read and index your repositories. Bito supports **GitHub**, **GitLab**, and **Bitbucket**. |
@@ -251,6 +254,7 @@ The setup script will guide you through configuring AI Architect with your Git p |
251 | 254 | - **Enterprise Git provider domain URL** - Provide your custom domain URL if you are using enterprise/self-hosted version of Git provider (e.g., https://github.company.com). |
252 | 255 | - **LLM Keys** (required unless you have a Bito Enterprise Plan) - We suggest you provide API keys for both **Anthropic** and **Grok** LLMs for the best cost and coverage. |
253 | 256 | - **Generate a secure MCP access token?** - Type `y` to generate a secure access token (recommended) |
| 257 | +- **Configure SSO?** - Optionally enable Single Sign-On (SSO) authentication. Choose between **Bito authentication** (OAuth via your Bito workspace) or **Enterprise IdP** (SAML/OIDC via your corporate identity provider). See [SSO Authentication](#6-sso-authentication) for more details. |
254 | 258 |
|
255 | 259 | > **LLM Rate Limit Requirements:** To ensure stable and uninterrupted operation, the configured LLM provider must support the following minimum rate limits: |
256 | 260 | > - **Requests Per Minute (RPM):** 300 |
@@ -428,9 +432,118 @@ If you prefer hands-on control over your configuration or encounter issues with |
428 | 432 |
|
429 | 433 | <br /> |
430 | 434 |
|
| 435 | +<!-- SSO Authentication --> |
| 436 | + |
| 437 | +## 6. SSO Authentication |
| 438 | + |
| 439 | +AI Architect supports Single Sign-On (SSO) authentication for secure, multi-user access to the MCP server. SSO runs entirely on-prem — no authentication traffic leaves your environment except for identity provider federation (if Enterprise IdP is configured) and Bito API calls for SSO configurations. |
| 440 | + |
| 441 | +### Authentication modes |
| 442 | + |
| 443 | +AI Architect supports three authentication modes: |
| 444 | + |
| 445 | +| Mode | Provider | How it works | |
| 446 | +|------|----------|--------------| |
| 447 | +| **Bearer Token** | None (SSO disabled) | Static MCP access token passed in the request header. This is the default mode. | |
| 448 | +| **Bito Authentication** | Bito | OAuth flow validated via your Bito workspace. Ideal for teams already using Bito. | |
| 449 | +| **Enterprise IdP** | Enterprise IdP | OAuth flow federated to your corporate SAML/OIDC identity provider (e.g., Okta, Azure AD, Google Workspace). | |
| 450 | + |
| 451 | +> **Note:** If Enterprise IdP is selected but not yet configured, the system automatically falls back to Bito authentication until the IdP setup is complete. |
| 452 | +
|
| 453 | +--- |
| 454 | + |
| 455 | +### Setting up SSO during installation |
| 456 | + |
| 457 | +SSO is configured during the `./setup.sh` process. When prompted with **"Configure SSO?"**, you can choose one of the following options: |
| 458 | + |
| 459 | +1. **Enterprise IdP (SAML/OIDC)** |
| 460 | + - The setup process generates a configuration URL for your identity provider |
| 461 | + - Open the URL in your browser and configure your IdP (e.g., Okta, Azure AD, Google Workspace) with the provided details |
| 462 | + - Return to the setup and verify the connection |
| 463 | + |
| 464 | +2. **Bito Authentication** |
| 465 | + - Enables OAuth authentication using your Bito workspace credentials |
| 466 | + - No additional IdP configuration is required |
| 467 | + |
| 468 | +> **Note:** You can also configure or reconfigure SSO at any time after installation using the `bitoarch sso setup` command. |
| 469 | +
|
| 470 | +--- |
| 471 | + |
| 472 | +### Configuring SSO after installation |
| 473 | + |
| 474 | +If you skipped SSO during initial setup or want to change your SSO configuration, you can use the following CLI commands: |
| 475 | + |
| 476 | +**Set up or reconfigure SSO:** |
| 477 | + |
| 478 | +```bash |
| 479 | +bitoarch sso setup |
| 480 | +``` |
| 481 | + |
| 482 | +This command will guide you through the SSO configuration process, including choosing between Enterprise IdP and Bito authentication. |
| 483 | + |
| 484 | +**Check SSO status:** |
| 485 | + |
| 486 | +```bash |
| 487 | +bitoarch sso status |
| 488 | +``` |
| 489 | + |
| 490 | +Displays the current SSO configuration and IdP connection status. |
| 491 | + |
| 492 | +--- |
| 493 | + |
| 494 | +### Managing SSO |
| 495 | + |
| 496 | +#### Enable SSO |
| 497 | + |
| 498 | +Re-enable SSO after it has been temporarily disabled: |
| 499 | + |
| 500 | +```bash |
| 501 | +bitoarch sso enable |
| 502 | +``` |
| 503 | + |
| 504 | +#### Disable SSO |
| 505 | + |
| 506 | +You can disable SSO either temporarily or permanently: |
| 507 | + |
| 508 | +```bash |
| 509 | +bitoarch sso disable |
| 510 | +``` |
| 511 | + |
| 512 | +You will be prompted to choose: |
| 513 | +- **Temporary disable** — Turns off SSO authentication but preserves your IdP configuration. You can re-enable it later with `bitoarch sso enable`. |
| 514 | +- **Permanent disable** — Removes the IdP configuration entirely and resets SSO settings. You will need to run `bitoarch sso setup` again to reconfigure. |
| 515 | + |
| 516 | +#### Rotate SSO management key |
| 517 | + |
| 518 | +Rotate the SSO tenant management key for security purposes: |
| 519 | + |
| 520 | +```bash |
| 521 | +bitoarch sso rotate-key |
| 522 | +``` |
| 523 | + |
| 524 | +> **Important:** After rotating the key, SSO services will restart automatically. Active sessions may need to re-authenticate. |
| 525 | +
|
| 526 | +--- |
| 527 | + |
| 528 | +### SSO session configuration |
| 529 | + |
| 530 | +SSO sessions are configurable with the following defaults: |
| 531 | + |
| 532 | +| Setting | Default | Description | |
| 533 | +|---------|---------|-------------| |
| 534 | +| Session duration | 360 minutes (6 hours) | How long a session remains valid | |
| 535 | +| Refresh token TTL | 300 minutes (5 hours) | How long a refresh token remains valid | |
| 536 | +| Max concurrent sessions | 2 | Maximum number of concurrent sessions per user | |
| 537 | + |
| 538 | +> **Note:** Session settings can be customized through environment variables in the `.env-bitoarch` configuration file. |
| 539 | +
|
| 540 | +--- |
| 541 | + |
| 542 | +<br /> |
| 543 | + |
431 | 544 | <!-- Configuring AI Architect for Bito AI Code Review Agent --> |
432 | 545 |
|
433 | | -## 6. Configuring AI Architect for Bito AI Code Review Agent |
| 546 | +## 7. Configuring AI Architect for Bito AI Code Review Agent |
434 | 547 |
|
435 | 548 | Now that you have **AI Architect** set up, you can take your code quality to the next level by integrating it with **[Bito's AI Code Review Agent](https://bito.ai/product/ai-code-review-agent/)**. This powerful combination delivers significantly more accurate and context-aware code reviews by leveraging the deep codebase knowledge graph that AI Architect has built. |
436 | 549 |
|
@@ -461,7 +574,7 @@ This enables the AI Code Review Agent to: |
461 | 574 |
|
462 | 575 | <!-- Command reference --> |
463 | 576 |
|
464 | | -## 7. Command reference |
| 577 | +## 8. Command reference |
465 | 578 |
|
466 | 579 | Quick reference to CLI commands for managing Bito's AI Architect. |
467 | 580 |
|
@@ -518,6 +631,16 @@ Quick reference to CLI commands for managing Bito's AI Architect. |
518 | 631 | | `bitoarch mcp-resources` | List MCP resources | View available data sources | |
519 | 632 | | `bitoarch mcp-info` | Show MCP configuration | Display URL and token info | |
520 | 633 |
|
| 634 | +### SSO management |
| 635 | + |
| 636 | +| Command | Description | Example | |
| 637 | +|---------|-------------|---------| |
| 638 | +| `bitoarch sso setup` | Configure SSO (Enterprise IdP or Bito) | Interactive SSO setup wizard | |
| 639 | +| `bitoarch sso status` | Check current SSO/IdP connection status | `bitoarch sso status` | |
| 640 | +| `bitoarch sso enable` | Enable SSO authentication | `bitoarch sso enable` | |
| 641 | +| `bitoarch sso disable` | Disable SSO (temporary or permanent) | `bitoarch sso disable` | |
| 642 | +| `bitoarch sso rotate-key` | Rotate SSO tenant management key | `bitoarch sso rotate-key` | |
| 643 | + |
521 | 644 | ### Output options |
522 | 645 |
|
523 | 646 | Add these flags to any command: |
@@ -550,7 +673,7 @@ bitoarch --version |
550 | 673 |
|
551 | 674 | <!-- Troubleshooting guide --> |
552 | 675 |
|
553 | | -## 8. Troubleshooting guide |
| 676 | +## 9. Troubleshooting guide |
554 | 677 |
|
555 | 678 | ```bash |
556 | 679 | # Check all services |
@@ -598,7 +721,7 @@ tail -f setup.log |
598 | 721 | --- |
599 | 722 |
|
600 | 723 |
|
601 | | -## 9. Upgrading AI Architect |
| 724 | +## 10. Upgrading AI Architect |
602 | 725 |
|
603 | 726 | [](#overview) |
604 | 727 |
|
@@ -687,7 +810,7 @@ To switch between deployment types (Docker to Kubernetes or Kubernetes to Docker |
687 | 810 |
|
688 | 811 | <!-- Support & contact --> |
689 | 812 |
|
690 | | -## 10. Support & contact |
| 813 | +## 11. Support & contact |
691 | 814 |
|
692 | 815 | For comprehensive information and guidance on the AI Architect, including installation and configuration instructions, please refer to our detailed **[documentation available here](https://docs.bito.ai/ai-architect/overview)**. Should you require further assistance or have any inquiries, our support team is readily available to assist you. |
693 | 816 |
|
|
0 commit comments