Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
e277c6b
sign up copy nits
msukkari Jul 10, 2025
846d2d0
first pass at new onboarding page
msukkari Jul 11, 2025
61a0b33
wip join onboard logic
msukkari Jul 11, 2025
6f46518
refactor auth provider fetch logic
msukkari Jul 12, 2025
955d60e
add member approval and invite link flag logic
msukkari Jul 12, 2025
44b8370
update join request flow and remove jit logic
msukkari Jul 12, 2025
a0fb330
onboard guard
msukkari Jul 12, 2025
6943ccf
nits, onboard role check, invite link enabled check
msukkari Jul 12, 2025
22d68a6
fix bg color issue in onboarding page
msukkari Jul 12, 2025
57c94f1
refactor onboard UI
msukkari Jul 12, 2025
6191bca
ui nits and more onboarding resource cards
msukkari Jul 12, 2025
d221657
revamp auth docs
msukkari Jul 13, 2025
644d46a
change member approval default behavior and updated docs
msukkari Jul 13, 2025
1ef491b
merge prisma migrations
msukkari Jul 13, 2025
4b68ed9
add id to resource card
msukkari Jul 13, 2025
e1a7d0d
feedback
msukkari Jul 13, 2025
1ba266a
feedback
msukkari Jul 14, 2025
f781ab1
feedback and fixed build
msukkari Jul 14, 2025
97fc0c3
settings drop down UI nit
msukkari Jul 14, 2025
abe959b
ui nits
msukkari Jul 14, 2025
04edbed
handle join when max capacity case
msukkari Jul 14, 2025
86189b2
add news data for member toggle
msukkari Jul 14, 2025
7b3e6e7
refactor for public access case
msukkari Jul 15, 2025
bdfef1c
add iap bridge to onboard logic
msukkari Jul 15, 2025
22b9e53
fetch member approval req and invite link enabled flag on server
msukkari Jul 15, 2025
db6ab06
ui nits
msukkari Jul 15, 2025
5819708
fix invite link enable toggle snapping issue
msukkari Jul 15, 2025
cf18a0d
ui nits
msukkari Jul 15, 2025
c714555
styling and ui nits, pass in invite id from server
msukkari Jul 15, 2025
96c5fc2
add mcp resource in onboard step
msukkari Jul 15, 2025
81e6b61
get invite link in server
msukkari Jul 15, 2025
b15b13a
Merge branch 'main' into msukkarieh/onboard
msukkari Jul 15, 2025
71ced6a
fix build issue
msukkari Jul 15, 2025
2666469
refactor docs on config
msukkari Jul 15, 2025
7ea5437
minor doc nit
msukkari Jul 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor docs on config
  • Loading branch information
msukkari committed Jul 15, 2025
commit 2666469eb235783f5e346ca5fb890181d7f054a5
2 changes: 1 addition & 1 deletion docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"group": "Configuration",
"pages": [
{
"group": "Connecting your code",
"group": "Indexing your code",
"pages": [
"docs/connections/overview",
"docs/connections/github",
Expand Down
36 changes: 19 additions & 17 deletions docs/docs/connections/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,24 @@ sidebarTitle: Overview
import SupportedPlatforms from '/snippets/platform-support.mdx'
import ConfigSchema from '/snippets/schemas/v3/index.schema.mdx'

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.
To index your code with Sourcebot, you must provide a configuration file. When running Sourcebot, this file must be mounted in a volume that is accessible to the container, with its
path specified in the `CONFIG_PATH` environment variable. For example:

A JSON configuration file is used to specify connections. For example:
```bash icon="terminal" Passing in a CONFIG_PATH to Sourcebot
docker run \
-v $(pwd)/config.json:/data/config.json \
-e CONFIG_PATH=/data/config.json \
... \ # other config
ghcr.io/sourcebot-dev/sourcebot:latest
```

## Config Schema

The configuration file defines a set of **connections**. 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.

```json
// Specifies two connections:
```json wrap icon="code" Example config with two connections
{
"$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
"connections": {
Expand Down Expand Up @@ -43,16 +55,7 @@ A JSON configuration file is used to specify connections. For example:

Configuration files must conform to the [JSON schema](#schema-reference).

When running Sourcebot, this file must be mounted in a volume that is accessible to the container, with its path specified in the `CONFIG_PATH` environment variable. For example:

```bash
docker run \
-v $(pwd)/config.json:/data/config.json \
-e CONFIG_PATH=/data/config.json \
... \ # other config
ghcr.io/sourcebot-dev/sourcebot:latest
```

## Config Syncing
Sourcebot performs syncing in the background. Syncing consists of two steps:
1. Fetch the latest changes from `HEAD` (and any [additional branches](/docs/features/search/multi-branch-indexing)) from the code host.
2. Re-indexes the repository.
Expand All @@ -70,10 +73,9 @@ On the home page, you can view the sync status of ongoing jobs:
src="https://framerusercontent.com/assets/7YyxK8ctPEy9Rf68X2kIdMI.mp4"
></video>

## Getting started
---
## Platform Connection Guides

To get started, pick a platform below and follow the instructions to connect your code.
To learn more about how to create a connection for a specific code host, check out the guides below.

<SupportedPlatforms />

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Overview"
---

Sourcebot is an open-source ([GitHub](https://github.com/sourcebot-dev/sourcebot)), self-hosted code search tool that is purpose built to help teams find and navigate code quickly, at scale.
Sourcebot is an open-source ([GitHub](https://github.com/sourcebot-dev/sourcebot)), self-hosted code search tool. It allows you to search and navigate across millions of lines of code across several code host platforms.

<CardGroup>
<Card title="Deployment guide" icon="server" href="/docs/deployment-guide" horizontal="true">
Expand All @@ -16,10 +16,10 @@ Sourcebot is an open-source ([GitHub](https://github.com/sourcebot-dev/sourcebot
<AccordionGroup>
<Accordion title="Why Sourcebot?">
- **Full-featured search:** Fast indexed-based search with regex support, filters, branch search, boolean logic, and more.
- **Self-hosted:** Ships as a single [docker container](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot) that can be deployed anywhere.
- **Self-hosted:** Deploy it in minutes using our official [docker container](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot). All of your data stays on your machine.
- **Modern design:** Light/Dark mode, vim keybindings, keyboard shortcuts, syntax highlighting, etc.
- **Scalable:** Scales to millions of lines of code.
- **Open-source:** Core features are MIT licensed, no vendor lock-in.
- **Open-source:** Core features are MIT licensed.
</Accordion>
</AccordionGroup>

Expand Down