You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
8
8
## [Unreleased]
9
9
10
+
Sourcebot V4 introduces authentication, performance improvements and code navigation. Checkout the [migration guide](https://docs.sourcebot.dev/self-hosting/upgrade/v3-to-v4-guide) for information on upgrading your instance to v4.
11
+
12
+
### Changed
13
+
-[**Breaking Change**] Authentication is now required by default. Notes:
14
+
- When setting up your instance, email / password login will be the default authentication provider.
15
+
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/more/roles-and-permissions)).
16
+
- Subsequent users can request to join the instance. The `owner` can approve / deny requests to join the instance via `Settings` > `Members` > `Pending Requests`.
17
+
- If a user is approved to join the instance, they are given the `member` role.
18
+
- Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/self-hosting/configuration/authentication)).
19
+
- 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)
20
+
10
21
### Added
11
-
-[Sourcebot EE] Added code navigation (find all references / go to definition). [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
22
+
-[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)
- Improved scroll performance for large numbers of search results. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
@@ -99,8 +111,8 @@ Sourcebot v3 is here and brings a number of structural changes to the tool's fou
99
111
### Added
100
112
- Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/self-hosting/overview#architecture).
101
113
- Added repo indexing progress indicators in the navbar.
102
-
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/self-hosting/more/authentication).
103
-
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/self-hosting/more/authentication)**:
114
+
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/self-hosting/configuration/authentication).
115
+
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/self-hosting/configuration/authentication)**:
104
116
- connection management: create and manage your JSON configs via a integrated web-editor.
105
117
- secrets: import personal access tokens (PAT) into Sourcebot (AES-256 encrypted). Reference secrets in your connection config by name.
106
118
- 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).
Copy file name to clipboardExpand all lines: docs/docs/connections/gitea.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ Next, provide the access token via the `token` property, either as an environmen
82
82
83
83
<Tabs>
84
84
<Tabtitle="Environment Variable">
85
-
<Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
85
+
<Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
86
86
87
87
1. Add the `token` property to your connection config:
88
88
```json
@@ -107,7 +107,7 @@ Next, provide the access token via the `token` property, either as an environmen
107
107
</Tab>
108
108
109
109
<Tabtitle="Secret">
110
-
<Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
110
+
<Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
111
111
112
112
1. Navigate to **Secrets** in settings and create a new secret with your PAT:
Copy file name to clipboardExpand all lines: docs/docs/connections/github.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,7 +111,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
111
111
112
112
<Tabs>
113
113
<Tabtitle="Environment Variable">
114
-
<Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
114
+
<Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
115
115
116
116
1. Add the `token` property to your connection config:
117
117
```json
@@ -136,7 +136,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
136
136
</Tab>
137
137
138
138
<Tabtitle="Secret">
139
-
<Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
139
+
<Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
140
140
141
141
1. Navigate to **Secrets** in settings and create a new secret with your PAT:
Copy file name to clipboardExpand all lines: docs/docs/connections/gitlab.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
116
116
117
117
<Tabs>
118
118
<Tabtitle="Environment Variable">
119
-
<Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
119
+
<Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
120
120
121
121
1. Add the `token` property to your connection config:
122
122
```json
@@ -141,7 +141,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
141
141
</Tab>
142
142
143
143
<Tabtitle="Secret">
144
-
<Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
144
+
<Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
145
145
146
146
1. Navigate to **Secrets** in settings and create a new secret with your PAT:
Copy file name to clipboardExpand all lines: docs/docs/connections/overview.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,11 @@ There are two ways to define connections:
11
11
12
12
<AccordionGroup>
13
13
<Accordiontitle="Declarative configuration file">
14
-
This is only supported when self-hosting, and is the default mechanism to define connections. Connections are defined in a [JSON file](/self-hosting/more/declarative-config)
14
+
This is only supported when self-hosting, and is the default mechanism to define connections. Connections are defined in a [JSON file](/self-hosting/configuration/declarative-config)
15
15
and the path to the file is provided through the `CONFIG_PATH` environment variable
16
16
</Accordion>
17
17
<Accordiontitle="UI connection management">
18
-
This is the only way to define connections when using Sourcebot Cloud, and can be configured when self-hosting by enabling [authentication](/self-hosting/more/authentications).
18
+
This is the only way to define connections when using Sourcebot Cloud, and can be configured when self-hosting by enabling [authentication](/self-hosting/configuration/authentications).
19
19
20
20
In this method, connections are defined and managed within the webapp:
This feature is only available with an active Enterprise license. Please add your [license key](/self-hosting/license-key) to activate it.
9
+
This feature is only available in [Sourcebot cloud](app.sourcebot.dev) or with an active Enterprise license when [self-hosting](/self-hosting). Please add your [license key](/self-hosting/license-key) to activate it.
10
10
</Note>
11
11
12
12
**Code navigation** allows you to jump between symbol definition and references when viewing source files in Sourcebot. This feature is enabled **automatically** when a valid license key is present and works with all popular programming languages.
@@ -16,7 +16,7 @@ A **search context** is a user-defined grouping of repositories that helps focus
16
16
-`( context:project1 or context:project2 ) logger\.debug` - search for debug log calls in project1 and project2
17
17
18
18
19
-
Search contexts are defined in the `context` object inside of a [declarative config](/self-hosting/more/declarative-config). Repositories can be included / excluded from a search context by specifying the repo's URL in either the `include` array or `exclude` array. Glob patterns are supported.
19
+
Search contexts are defined in the `context` object inside of a [declarative config](/self-hosting/configuration/declarative-config). Repositories can be included / excluded from a search context by specifying the repo's URL in either the `include` array or `exclude` array. Glob patterns are supported.
20
20
21
21
## Example
22
22
@@ -41,7 +41,7 @@ shared/
41
41
├─ ...
42
42
```
43
43
44
-
To make searching easier, we can create three search contexts in our [config.json](/self-hosting/more/declarative-config):
44
+
To make searching easier, we can create three search contexts in our [config.json](/self-hosting/configuration/declarative-config):
Copy file name to clipboardExpand all lines: docs/self-hosting/configuration/tenancy.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ sidebarTitle: Multi tenancy
4
4
---
5
5
6
6
<Warning>If you're switching from single-tenant mode, delete the Sourcebot cache (the `.sourcebot` folder) before starting.</Warning>
7
-
<Warning>[Authentication](/self-hosting/more/authentication) must be enabled to enable multi tenancy mode</Warning>
7
+
<Warning>[Authentication](/self-hosting/configuration/authentication) must be enabled to enable multi tenancy mode</Warning>
8
8
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
9
9
named `SOURCEBOT_TENANCY_MODE` and set its value to `multi`. When multi tenancy mode is enabled:
Copy file name to clipboardExpand all lines: docs/self-hosting/upgrade/v3-to-v4-guide.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This guide will walk you through upgrading your Sourcebot deployment from v3 to
8
8
<Warning>
9
9
Please note that the following features are no longer supported in v4:
10
10
- Multi-tenancy mode
11
-
-Unauthorized access to a Sourcebot deployment. Authentication is now required, and unauthorized access requires an unlimited seat [enterprise license](/self-hosting/license-key)
11
+
-Unauthenticated access to a Sourcebot deployment - authentication is now built in by default. Unauthenticated access to a organization can be enabled with an unlimited seat [enterprise license](/self-hosting/license-key)
12
12
</Warning>
13
13
14
14
### If your deployment doesn't have authentication enabled
0 commit comments