Skip to content

Commit aa834a0

Browse files
brendan-kellambrendan-kellam
committed
further wip on docs
1 parent 6df4b11 commit aa834a0

File tree

4 files changed

+99
-17
lines changed

4 files changed

+99
-17
lines changed

‎docs/docs/connections/overview.mdx

Lines changed: 63 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,71 @@ sidebarTitle: Overview
44
---
55

66
import SupportedPlatforms from '/snippets/platform-support.mdx'
7+
import ConfigSchema from '/snippets/schemas/v3/index.schema.mdx'
78

8-
{/* TODO: document the concept of connections, the JSON schema, etc. */}
9+
A **connection** in Sourcebot represents a link to a code host (such as GitHub, GitLab, Bitbucket, etc.). Each connection defines how Sourcebot should authenticate and interact with a particular host, and which repositories to sync and index from that host. Connections are uniquely identified by their name.
910

10-
### Supported code hosts
11+
A JSON configuration file is used to specify connections. For example:
12+
13+
```json
14+
// Specifies two connections:
15+
{
16+
"$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
17+
"connections": {
18+
// 1. A connection to GitHub.com
19+
"github-connection": {
20+
"type": "github",
21+
"repos": [
22+
"sourcebot-dev/sourcebot"
23+
],
24+
"token": {
25+
"env": "GITHUB_TOKEN"
26+
}
27+
},
28+
// 2. A self-hosted GitLab instance
29+
"gitlab-connection": {
30+
"type": "gitlab",
31+
"url": "https://gitlab.example.com",
32+
"groups": [
33+
"my-group",
34+
"my-other-group/sub-group"
35+
],
36+
"token": {
37+
"env": "GITLAB_TOKEN"
38+
}
39+
}
40+
}
41+
}
42+
```
43+
44+
Configuration files must conform to the [JSON schema](https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json).
45+
46+
When running Sourcebot, this file must be mounted in a volume that is accessible to the container, with it's path specified in the `CONFIG_FILE` environment variable. For example:
47+
48+
```bash
49+
docker run \
50+
-v $(pwd)/config.json:/data/config.json \
51+
-e CONFIG_FILE=/data/config.json \
52+
... \ # other config
53+
ghcr.io/sourcebot-dev/sourcebot:latest
54+
```
55+
56+
## Getting started
57+
---
58+
59+
To get started, pick a platform below and follow the instructions to connect your code.
1160

1261
<SupportedPlatforms />
1362

14-
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
63+
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
64+
65+
66+
## Schema reference
67+
---
68+
69+
<Accordion title="Reference">
70+
[schemas/v3/index.json](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/index.json)
71+
72+
<ConfigSchema />
73+
74+
</Accordion>

‎docs/docs/deployment-guide.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,6 @@ Watch this 1:51 minute video to get a quick overview of how to deploy Sourcebot
8686
The first account which is registered on a fresh Sourcebot deployment is given the [owner role](/docs/configuration/auth/roles-and-permissions).
8787
</Note>
8888
</Step>
89-
90-
<Step title="Link your code">
91-
Sourcebot supports indexing public & private code on the following code hosts:
92-
93-
<SupportedPlatforms />
94-
95-
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
96-
</Step>
97-
9889
</Steps>
9990

10091
## Next steps

‎docs/docs/license-key.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ sidebarTitle: License key
77
If you'd like a trial license, [reach out](https://www.sourcebot.dev/contact) and we'll send one over within 24 hours
88
</Note>
99

10-
All core Sourcebot features are available in Sourcebot OSS (MIT Licensed). Some additional features require a license key. See the [pricing page](https://www.sourcebot.dev/pricing) for more details.
10+
All core Sourcebot features are available in Sourcebot OSS (MIT Licensed) without any limits. Some additional features require a license key. See the [pricing page](https://www.sourcebot.dev/pricing) for more details.
1111

1212

1313
## Activating a license key
14+
---
1415

1516
After purchasing a license key, you can activate it by setting the `SOURCEBOT_EE_LICENSE_KEY` environment variable.
1617

@@ -21,6 +22,22 @@ docker run \
2122
ghcr.io/sourcebot-dev/sourcebot:latest
2223
```
2324

25+
## Feature availability
26+
---
27+
28+
| Feature | OSS | Licensed |
29+
|:---------|:-----|:----------|
30+
| [Search](/docs/features/search/overview) | ✅ | ✅ |
31+
| [Full code host support](/docs/connections/overview) | ✅ | ✅ |
32+
| [MCP Server](/docs/features/mcp-server) | ✅ | ✅ |
33+
| [Agents](/docs/features/agents/overview) | ✅ | ✅ |
34+
| [Login with credentials](/docs/configuration/auth/overview) | ✅ | ✅ |
35+
| [Login with email codes](/docs/configuration/auth/overview) | ✅ | ✅ |
36+
| [Login with SSO](/docs/configuration/auth/overview#enterprise-authentication-providers) | 🛑 | ✅ |
37+
| [Code navigation](/docs/features/code-navigation) | 🛑 | ✅ |
38+
| [Search contexts](/docs/features/search/search-contexts) | 🛑 | ✅ |
39+
40+
2441
## Questions?
2542

2643
If you have any questions regarding licensing, please [contact us](https://www.sourcebot.dev/contact).

‎docs/docs/overview.mdx

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,21 @@ title: "Overview"
66
77
<AccordionGroup>
88
<Accordion title="Why Sourcebot?">
9-
- **Open-source:**
10-
- **Fast:** Search across millions of lines of code in seconds using Sourcebot's blazingly fast indexed search.
11-
- **Scalable:** Sourcebot uses [trigram indexing](https://en.wikipedia.org/wiki/Trigram_search), allowing it to scale to massive codebases.
12-
- **Self-hosted:** Sourcebot is designed to be easily self-hosted, allowing you to deploy it onto your own infrastructure, keeping your code private and secure.
9+
- **Full-featured search:** Fast indexed-based search with regex support, filters, branch search, boolean logic, and more.
10+
- **Self-hosted:** Ships as a single [docker container](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot) that can be deployed anywhere.
11+
- **Modern design:** Light/Dark mode, vim keybindings, keyboard shortcuts, syntax highlighting, etc.
12+
- **Scalable:** Scales to millions of lines of code.
13+
- **Open-source:** Core features are MIT licensed, no vendor lock-in.
1314
</Accordion>
1415
</AccordionGroup>
1516

1617
## Features
1718
---
1819

20+
<Info>
21+
Find an overview of all Sourcebot features below. For details, see the individual documentation pages.
22+
</Info>
23+
1924
### Fast-indexed based search
2025

2126
Search across millions of lines of code in seconds using Sourcebot's blazingly fast indexed search. Find exactly what you are looking for with regular expressions, search filters, boolean logic, and more.
@@ -157,6 +162,15 @@ One of our design philosophies for Sourcebot is to keep our infrastructure [radi
157162

158163
Sourcebot does not support horizontal scaling at this time, but it is on our roadmap. If this is something your team would be interested in, please contact us at [team@sourcebot.dev](mailto:team@sourcebot.dev).
159164

165+
## License key
166+
---
167+
168+
Sourcebot's core features are available under an [MIT license](https://github.com/sourcebot-dev/sourcebot/blob/HEAD/LICENSE) without any limits. Some [additional features](/docs/license-key#feature-availability) such as SSO and code navigation require a [license key](/docs/license-key).
169+
170+
<CardGroup cols={2}>
171+
<Card title="Pricing page" href="https://www.sourcebot.dev/pricing" />
172+
<Card title="Request trial key" href="https://www.sourcebot.dev/contact" />
173+
</CardGroup>
160174

161175
## Telemetry
162176
---

0 commit comments

Comments
 (0)