Skip to content

Commit c96d2cd

Browse files
brendan-kellambrendan-kellam
committed
further wip
1 parent 34105cd commit c96d2cd

37 files changed

+218
-260
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ Sourcebot V4 introduces authentication, performance improvements and code naviga
2222
### Changed
2323
- [**Breaking Change**] Authentication is now required by default. Notes:
2424
- When setting up your instance, email / password login will be the default authentication provider.
25-
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/more/roles-and-permissions)).
25+
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/configuration/auth/roles-and-permissions)).
2626
- Subsequent users can request to join the instance. The `owner` can approve / deny requests to join the instance via `Settings` > `Members` > `Pending Requests`.
2727
- If a user is approved to join the instance, they are given the `member` role.
28-
- Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/docs/configuration/authentication)).
28+
- Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/docs/configuration/auth/overview)).
2929
- Clicking on a search result now takes you to the `/browse` view. Files can still be previewed by clicking the "Preview" button or holding `Cmd` / `Ctrl` when clicking on a search result. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
3030

3131
### Added
32-
- [Sourcebot EE] Added search-based code navigation, allowing you to jump between symbol definition and references when viewing source files. [Read the documentation](https://docs.sourcebot.dev/docs/search/code-navigation). [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
32+
- [Sourcebot EE] Added search-based code navigation, allowing you to jump between symbol definition and references when viewing source files. [Read the documentation](https://docs.sourcebot.dev/docs/features/code-navigation). [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
3333
- Added collapsible filter panel. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
3434
- Added Sourcebot API key management for external clients. [#311](https://github.com/sourcebot-dev/sourcebot/pull/311)
3535

@@ -44,7 +44,7 @@ Sourcebot V4 introduces authentication, performance improvements and code naviga
4444
## [3.2.0] - 2025-05-12
4545

4646
### Added
47-
- Added AI code review agent [#298](https://github.com/sourcebot-dev/sourcebot/pull/298). Checkout the [docs](https://docs.sourcebot.dev/docs/agents/review-agent) for more information.
47+
- Added AI code review agent [#298](https://github.com/sourcebot-dev/sourcebot/pull/298). Checkout the [docs](https://docs.sourcebot.dev/docs/features/agents/review-agent) for more information.
4848

4949
### Fixed
5050
- Fixed issue with repos appearing in the carousel when they fail indexing for the first time. [#305](https://github.com/sourcebot-dev/sourcebot/pull/305)
@@ -122,11 +122,11 @@ Sourcebot v3 is here and brings a number of structural changes to the tool's fou
122122
### Added
123123
- Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/docs/overview#architecture).
124124
- Added repo indexing progress indicators in the navbar.
125-
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/docs/configuration/authentication).
126-
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/docs/configuration/authentication)**:
125+
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/docs/configuration/auth/overview).
126+
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/docs/configuration/auth/overview)**:
127127
- connection management: create and manage your JSON configs via a integrated web-editor.
128128
- secrets: import personal access tokens (PAT) into Sourcebot (AES-256 encrypted). Reference secrets in your connection config by name.
129-
- team & invite management: invite users to your instance to give them access. Configure team [roles & permissions](https://docs.sourcebot.dev/docs/more/roles-and-permissions).
129+
- team & invite management: invite users to your instance to give them access. Configure team [roles & permissions](https://docs.sourcebot.dev/docs/configuration/auth/roles-and-permissions).
130130
- Added multi-tenancy support. See [this doc](https://docs.sourcebot.dev/self-hosting/more/tenancy).
131131

132132
### Removed

‎docs/development.mdx

Lines changed: 0 additions & 107 deletions
This file was deleted.

‎docs/docs.json

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,30 @@
2121
"group": "Getting Started",
2222
"pages": [
2323
"docs/overview",
24-
"docs/quick-start-guide",
25-
"docs/license-key"
24+
"docs/deployment-guide"
25+
]
26+
},
27+
{
28+
"group": "Features",
29+
"pages": [
30+
{
31+
"group": "Search",
32+
"pages": [
33+
"docs/features/search/syntax-reference",
34+
"docs/features/search/multi-branch-indexing",
35+
"docs/features/search/search-contexts"
36+
]
37+
},
38+
"docs/features/code-navigation",
39+
"docs/features/mcp-server",
40+
{
41+
"group": "Agents",
42+
"tag": "experimental",
43+
"pages": [
44+
"docs/features/agents/overview",
45+
"docs/features/agents/review-agent"
46+
]
47+
}
2648
]
2749
},
2850
{
@@ -43,35 +65,18 @@
4365
"docs/connections/request-new"
4466
]
4567
},
68+
"docs/license-key",
4669
"docs/configuration/environment-variables",
47-
"docs/configuration/authentication",
70+
{
71+
"group": "Authentication",
72+
"pages": [
73+
"docs/configuration/auth/overview",
74+
"docs/configuration/auth/roles-and-permissions"
75+
]
76+
},
4877
"docs/configuration/transactional-emails"
4978
]
5079
},
51-
{
52-
"group": "Search",
53-
"pages": [
54-
"docs/search/syntax-reference",
55-
"docs/search/multi-branch-indexing",
56-
"docs/search/code-navigation",
57-
"docs/search/search-contexts"
58-
]
59-
},
60-
{
61-
"group": "Agents",
62-
"pages": [
63-
"docs/agents/overview",
64-
"docs/agents/review-agent"
65-
]
66-
},
67-
{
68-
"group": "More",
69-
"pages": [
70-
"docs/more/api-keys",
71-
"docs/more/roles-and-permissions",
72-
"docs/more/mcp-server"
73-
]
74-
},
7580
{
7681
"group": "Upgrade",
7782
"pages": [

‎docs/docs/configuration/authentication.mdx renamed to ‎docs/docs/configuration/auth/overview.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: Authentication
3-
sidebarTitle: Authentication
2+
title: Overview
43
---
54

6-
<Warning>Make sure the `AUTH_URL` environment variable is [configured correctly](/self-hosting/configuration) when using Sourcebot behind a domain.</Warning>
7-
85
Sourcebot has built-in authentication that gates access to your organization. OAuth, email codes, and email / password are supported.
96

10-
The first account that's registered on a Sourcebot deployment is made the owner. All other users who register must be [approved](/docs/configuration/authentication#approving-new-members) by the owner.
7+
The first account that's registered on a Sourcebot deployment is made the owner. All other users who register must be [approved](/docs/configuration/auth/overview#approving-new-members) by the owner.
118

129
![Login Page](/images/login.png)
1310

@@ -16,7 +13,7 @@ The first account that's registered on a Sourcebot deployment is made the owner.
1613

1714
All account registrations after the first account must be approved by the owner. The owner can see all join requests by going into **Settings -> Members**.
1815

19-
If you have an [enterprise license](/docs/license-key), you can enable [AUTH_EE_ENABLE_JIT_PROVISIONING](/docs/configuration/authentication#enterprise-authentication-providers) to
16+
If you have an [enterprise license](/docs/license-key), you can enable [AUTH_EE_ENABLE_JIT_PROVISIONING](/docs/configuration/auth/overview#enterprise-authentication-providers) to
2017
have Sourcebot accounts automatically created and approved on registration.
2118

2219
You can setup emails to be sent when new join requests are created/approved by configurating [transactional emails](/docs/configuration/transactional-emails)
@@ -43,6 +40,8 @@ See [transactional emails](/docs/configuration/transactional-emails) for more de
4340

4441
## Enterprise Authentication Providers
4542

43+
<Warning>If you're deploying Sourcebot behind a domain, you must set the [AUTH_URL](/docs/configuration/environment-variables) environment variable to use these providers.</Warning>
44+
4645
The following authentication providers require an [enterprise license](/docs/license-key) to be enabled.
4746

4847
By default, a new user registering using these providers must have their join request accepted by the owner of the organization to join. To allow a user to join automatically when

‎docs/docs/more/roles-and-permissions.mdx renamed to ‎docs/docs/configuration/auth/roles-and-permissions.mdx

File renamed without changes.

‎docs/docs/configuration/environment-variables.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
2-
title: Environment Variables
3-
sidebarTitle: Environment Variables
2+
title: Environment variables
3+
sidebarTitle: Environment variables
4+
mode: "wide"
45
---
56

6-
<Note>This page provides a detailed reference of all environment variables supported by Sourcebot. If you're just looking to get up and running, we recommend starting with the [getting started](/self-hosting/overview) guide instead.</Note>
7+
<Note>This page provides a detailed reference of all environment variables supported by Sourcebot. If you're just looking to get up and running, we recommend starting with the [deployment guide](/docs/deployment-guide) instead.</Note>
78

89
### Core Environment Variables
910
The following environment variables allow you to configure your Sourcebot deployment.
1011

1112
| Variable | Default | Description |
1213
| :------- | :------ | :---------- |
13-
| `AUTH_CREDENTIALS_LOGIN_ENABLED` | `true` | <p>Enables/disables authentication with basic credentials. Username and passwords are stored encrypted at rest within the postgres database. Checkout the [auth docs](/docs/configuration/authentication) for more info</p> |
14-
| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` | <p>Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/docs/configuration/authentication) for more info </p> |
14+
| `AUTH_CREDENTIALS_LOGIN_ENABLED` | `true` | <p>Enables/disables authentication with basic credentials. Username and passwords are stored encrypted at rest within the postgres database. Checkout the [auth docs](/docs/configuration/auth/overview) for more info</p> |
15+
| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` | <p>Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/docs/configuration/auth/overview) for more info </p> |
1516
| `AUTH_SECRET` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 33` | <p>Used to validate login session cookies</p> |
1617
| `AUTH_URL` | - | <p>URL of your Sourcebot deployment, e.g., `https://example.com` or `http://localhost:3000`.</p> |
1718
| `CONFIG_PATH` | `-` | <p>The container relative path to the declerative configuration file. See [this doc](/docs/configuration/declarative-config) for more info.</p> |
@@ -26,7 +27,7 @@ The following environment variables allow you to configure your Sourcebot deploy
2627
| `SMTP_CONNECTION_URL` | `-` | <p>The url to the SMTP service used for sending transactional emails. See [this doc](/docs/configuration/transactional-emails) for more info.</p> |
2728
| `SOURCEBOT_ENCRYPTION_KEY` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 24` | <p>Used to encrypt connection secrets and generate API keys.</p> |
2829
| `SOURCEBOT_LOG_LEVEL` | `info` | <p>The Sourcebot logging level. Valid values are `debug`, `info`, `warn`, `error`, in order of severity.</p> |
29-
| `SOURCEBOT_TELEMETRY_DISABLED` | `false` | <p>Enables/disables telemetry collection in Sourcebot. See [this doc](/self-hosting/security/telemetry) for more info.</p> |
30+
| `SOURCEBOT_TELEMETRY_DISABLED` | `false` | <p>Enables/disables telemetry collection in Sourcebot. See [this doc](/docs/overview.mdx#telemetry) for more info.</p> |
3031
| `TOTAL_MAX_MATCH_COUNT` | `100000` | <p>The maximum number of matches per query</p> |
3132
| `ZOEKT_MAX_WALL_TIME_MS` | `10000` | <p>The maximum real world duration (in milliseconds) per zoekt query</p> |
3233

‎docs/docs/configuration/tenancy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: Multi tenancy
44
---
55

66
<Warning>If you're switching from single-tenant mode, delete the Sourcebot cache (the `.sourcebot` folder) before starting.</Warning>
7-
<Warning>[Authentication](/docs/configuration/authentication) must be enabled to enable multi tenancy mode</Warning>
7+
<Warning>[Authentication](/docs/configuration/auth/overview) must be enabled to enable multi tenancy mode</Warning>
88
Multi tenancy allows your Sourcebot deployment to have **multiple organizations**, each with their own set of members and repos. To enable multi tenancy mode, define an environment variable
99
named `SOURCEBOT_TENANCY_MODE` and set its value to `multi`. When multi tenancy mode is enabled:
1010

‎docs/docs/configuration/transactional-emails.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To enable transactional emails in your deployment, set the following environment
77

88
- Send emails when new members are invited
99
- Send emails when organization join requests are created/accepted
10-
- Log into the Sourcebot deployment using [email codes](self-hosting/more/authentication#email-codes)
10+
- Log into the Sourcebot deployment using [email codes](/docs/configuration/auth/overview#email-codes)
1111

1212
| Variable | Description |
1313
| :------- | :---------- |

‎docs/docs/connections/gitea.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Next, provide the access token via the `token` property, either as an environmen
108108
</Tab>
109109

110110
<Tab title="Secret">
111-
<Note>Secrets are only supported when [authentication](/docs/configuration/authentication) is enabled.</Note>
111+
<Note>Secrets are only supported when [authentication](/docs/configuration/auth/overview) is enabled.</Note>
112112

113113
1. Navigate to **Secrets** in settings and create a new secret with your PAT:
114114

‎docs/docs/connections/github.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
137137
</Tab>
138138

139139
<Tab title="Secret">
140-
<Note>Secrets are only supported when [authentication](/docs/configuration/authentication) is enabled.</Note>
140+
<Note>Secrets are only supported when [authentication](/docs/configuration/auth/overview) is enabled.</Note>
141141

142142
1. Navigate to **Secrets** in settings and create a new secret with your PAT:
143143

0 commit comments

Comments
 (0)