Skip to content

Commit 161f3b2

Browse files
brendan-kellambrendan-kellam
committed
fixes
1 parent 3d7a4fe commit 161f3b2

File tree

9 files changed

+38
-25
lines changed

9 files changed

+38
-25
lines changed

‎docs/docs/connections/gitea.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,10 @@ Next, provide the access token via the `token` property, either as an environmen
9797

9898
2. Pass this environment variable each time you run Sourcebot:
9999
```bash
100-
docker run -e GITEA_TOKEN=<PAT> ... ghcr.io/sourcebot-dev/sourcebot:latest
100+
docker run \
101+
-e GITEA_TOKEN=<PAT> \
102+
/* additional args */ \
103+
ghcr.io/sourcebot-dev/sourcebot:latest
101104
```
102105
</Tab>
103106

‎docs/docs/connections/github.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,10 @@ Next, provide the PAT via the `token` property, either as an environment variabl
126126

127127
2. Pass this environment variable each time you run Sourcebot:
128128
```bash
129-
docker run -e GITHUB_TOKEN=<PAT> ... ghcr.io/sourcebot-dev/sourcebot:latest
129+
docker run \
130+
-e GITHUB_TOKEN=<PAT> \
131+
/* additional args */ \
132+
ghcr.io/sourcebot-dev/sourcebot:latest
130133
```
131134
</Tab>
132135

‎docs/docs/connections/gitlab.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,10 @@ Next, provide the PAT via the `token` property, either as an environment variabl
131131

132132
2. Pass this environment variable each time you run Sourcebot:
133133
```bash
134-
docker run -e GITLAB_TOKEN=<PAT> ... ghcr.io/sourcebot-dev/sourcebot:latest
134+
docker run \
135+
-e GITLAB_TOKEN=<PAT> \
136+
/* additional args */ \
137+
ghcr.io/sourcebot-dev/sourcebot:latest
135138
```
136139
</Tab>
137140

‎docs/docs/connections/overview.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ There are two ways to define connections:
99

1010
<AccordionGroup>
1111
<Accordion title="Declarative configuration file">
12-
This is only supported when self-hosting, and is the default mechanism to define connections. Connections are defined in a [JSON file](http://localhost:3001/self-hosting/more/declarative-config)
12+
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)
1313
and the path to the file is provided through the `CONFIG_PATH` environment variable
1414
</Accordion>
1515
<Accordion title="UI connection management">
16-
This is the only way to define connections when using Sourcebot Cloud, and can be enabled when self-hosting by enabling [authentication](/self-hosting/more/authentications).
16+
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).
1717

1818
In this method, connections are defined and managed within the webapp:
1919

@@ -28,4 +28,6 @@ There are two ways to define connections:
2828
<Card horizontal title="GitLab" icon="gitlab" href="/docs/connections/gitlab" />
2929
<Card horizontal title="Gitea" href="/docs/connections/gitea" />
3030
<Card horizontal title="Gerrit" href="/docs/connections/gerrit" />
31-
</CardGroup>
31+
</CardGroup>
32+
33+
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>

‎docs/docs/getting-started.mdx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This page will provide a quick walkthrough of how to get onboarded on Sourcebot,
3636
- Secret (optional): An [access token](/access-tokens/overview) that is used to fetch private repos
3737
- Configuration: The JSON configuration schema that defines the repos/orgs to fetch.
3838

39-
For a more detailed explanation of connections, check out the [Connections](/connections/overview) page.
39+
For a more detailed explanation of connections, check out the [Connections](/docs/connections/overview) page.
4040

4141
The example below shows a connection named `sourcebot-org` that fetches all of the repos for the `sourcebot-dev` GitHub organization, but excludes the `sourcebot-dev/zoekt` repo
4242

@@ -52,5 +52,4 @@ of the repos you've indexed
5252

5353
![Onboard Complete](/images/onboard_complete.png)
5454

55-
Congrats, you've successfuly setup Sourcebot! Read on to learn more about the Sourcebot's capabilities
56-
- Checkout the [Connections](/connections/overview) page to learn how to control which repos Sourcebot fetches
55+
Congrats, you've successfuly setup Sourcebot! Read on to learn more about the Sourcebot's capabilities. Checkout the [Connections](/docs/connections/overview) page to learn how to control which repos Sourcebot fetches

‎docs/docs/overview.mdx‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Overview"
44

55
import ConnectionCards from '/snippets/connection-cards.mdx';
66

7-
Sourcebot is an **[open-source](https://github.com/sourcebot-dev/) code search tool** that is purpose built to search multi-million line codebases in seconds. It integrates with [GitHub](/docs/connections/github), [GitLab](/docs/connections/gitlab), and [other platforms](/docs/connections).
7+
Sourcebot is an **[open-source](https://github.com/sourcebot-dev/sourcebot) code search tool** that is purpose built to search multi-million line codebases in seconds. It integrates with [GitHub](/docs/connections/github), [GitLab](/docs/connections/gitlab), and [other platforms](/docs/connections).
88

99
## Getting Started
1010

@@ -20,9 +20,3 @@ There are two ways to get started using Sourcebot:
2020
</CardGroup>
2121

2222
We also have a [public demo](https://sourcebot.dev/search) if you'd like to try Sourcebot out before registering.
23-
24-
# Platform Support
25-
26-
Sourcebot can index repositories across various different code host platforms.
27-
28-
<ConnectionCards />

‎docs/self-hosting/more/authentication.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebarTitle: Authentication
99
Sourcebot has built-in authentication that gates access to your organization. OAuth, email codes, and email / password are supported. To enable authentication, set the `SOURCEBOT_AUTH_ENABLED` environment variable to `true`.
1010
When authentication is enabled:
1111

12-
- Connection managment happens through the UI
12+
- [Connection managment](/docs/connections/overview) happens through the UI
1313
- Members must be invited to an organization to gain access
1414
- If you're in single-tenant mode, the first user to register will be made the owner of the default organization. Check out the [roles page](/docs/more/roles-and-permissions) for more info on the different roles and permissions
1515

‎docs/self-hosting/more/tenancy.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ named `SOURCEBOT_AUTH_ENABLED` and set its value to `multi`. When multi tenancy
1616
### Organization creation form
1717

1818
When you sign in for the first time (assuming you didn't go through an invite), you'll be presented with the organization creation form. The member who creates
19-
the organization will be the Owner. The
19+
the organization will be the Owner.
2020

2121
![Org creation](/images/org_create.png)
2222

‎docs/self-hosting/overview.mdx‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Sourcebot is open source and can be self-hosted using our official [Docker image
2323

2424
<Steps>
2525
<Step title="Create a config">
26-
By default, Sourcebot requires a [configuration file](/self-hosting/more/declarative-config) with a list of [code host connections](/docs/connections/overview) that specify what repositories should be **synced** (cloned and indexed). To get started, run the following command to create a starter `config.json`:
26+
By default, Sourcebot requires a configuration file with a list of [code host connections](/docs/connections/overview) that specify what repositories should be **synced** (cloned and indexed). To get started, run the following command to create a starter `config.json`:
2727

2828
```bash
2929
touch config.json
@@ -48,15 +48,22 @@ Sourcebot is open source and can be self-hosted using our official [Docker image
4848
Sourcebot is packaged as a [single Docker image](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot). In the same directory as `config.json`, run the following command to start your instance:
4949

5050
``` bash
51-
docker run -p 3000:3000 --pull=always --rm -v $(pwd):/data -e CONFIG_PATH=/data/config.json --name sourcebot ghcr.io/sourcebot-dev/sourcebot:latest
51+
docker run \
52+
-p 3000:3000 \
53+
--pull=always \
54+
--rm \
55+
-v $(pwd):/data \
56+
-e CONFIG_PATH=/data/config.json \
57+
--name sourcebot \
58+
ghcr.io/sourcebot-dev/sourcebot:latest
5259
```
5360

5461
Navigate to `localhost:3000` to start searching the Sourcebot repo.
5562

5663
<Accordion title="Details">
57-
**This command will**:
64+
**This command**:
5865
- pulls the latest version of the `sourcebot` docker image.
59-
- mounts the working directory to `/data` in the container to allow Sourcebot to persist data (like Postgres & Redis) across restarts, and to access the `config.json`. In your local directory, you should see a `.sourcebot` folder created that contains all persistent data.
66+
- mounts the working directory to `/data` in the container to allow Sourcebot to persist data across restarts, and to access the `config.json`. In your local directory, you should see a `.sourcebot` folder created that contains all persistent data.
6067
- runs any pending database migrations.
6168
- starts up all services, including the webserver exposed on port 3000.
6269
- reads `config.json` and starts syncing.
@@ -105,13 +112,15 @@ Sourcebot does not support horizontal scaling at this time, but it is on our roa
105112

106113

107114
## Telemetry
108-
109-
By default, Sourcebot collects anonymized usage data through [PostHog](https://posthog.com/) to help us improve the performance and reliability of our tool. We don't collect or transmit [any information related to your codebase](https://sourcebot.dev/search/search?query=captureEvent%5C(%20repo%3Asourcebot). In addition, all events are [sanitized](https://github.com/sourcebot-dev/sourcebot/blob/HEAD/packages/web/src/app/posthogProvider.tsx) to ensure that no sensitive details (ex. ip address, query info) leave your machine.
115+
By default, Sourcebot collects anonymized usage data through [PostHog](https://posthog.com/) to help us improve the performance and reliability of our tool. We don't collect or transmit <a href="https://sourcebot.dev/search/search?query=captureEvent%5C(%20repo%3Asourcebot">any information related to your codebase</a>. In addition, all events are [sanitized](https://github.com/sourcebot-dev/sourcebot/blob/HEAD/packages/web/src/app/posthogProvider.tsx) to ensure that no sensitive details (ex. ip address, query info) leave your machine.
110116

111117
The data we collect includes general usage statistics and metadata such as query performance (e.g., search duration, error rates) to monitor the application's health and functionality. This information helps us better understand how Sourcebot is used and where improvements can be made.
112118

113119
If you'd like to disable all telemetry, you can do so by setting the environment variable `SOURCEBOT_TELEMETRY_DISABLED` to `true`:
114120

115121
```bash
116-
docker run -e SOURCEBOT_TELEMETRY_DISABLED=true /* additional args */ ghcr.io/sourcebot-dev/sourcebot:latest
122+
docker run \
123+
-e SOURCEBOT_TELEMETRY_DISABLED=true \
124+
/* additional args */ \
125+
ghcr.io/sourcebot-dev/sourcebot:latest
117126
```

0 commit comments

Comments
 (0)