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
* add initial sections for new getting started section in README
* add missing section reference
* simplify english in workspace section
* additional language around mounting and running
* nit, browser language
* add info on how to edit config file and cleanup old docs
* add features section
* made readme more concise
* fix github icon
* missed a github icon
* fixed links in build section
* remove CONFIG_PATH setting in one command instruction:
1. Create a `config.json` file and list the repositories you want to index. The JSON schema [index.json](./schemas/index.json) defines the structure of the config file and the available options. For example, if we want to index Sourcebot on its own code, we could use the following config found in `sample-config.json`:
39
+
```
40
+
docker run -p 3000:3000 --rm --name sourcebot ghcr.io/taqlaai/sourcebot:main
Navigate to `localhost:3000` to start searching the Sourcebot repo. Want to search your own repos? Checkout how to [configure Sourcebot](#configuring-sourcebot).
47
44
48
-
Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](./schemas/index.json) for a full list of available options.
45
+
<details>
46
+
<summary>What does this command do?</summary>
49
47
50
-
2. Create a Personal Access Token (PAT) to authenticate with a code host(s):
48
+
- Pull and run the Sourcebot docker image from [ghcr.io/taqlaai/sourcebot:main](https://github.com/taqlaai/sourcebot/pkgs/container/sourcebot). You'll need to make sure you have [docker installed](https://docs.docker.com/get-started/get-docker/) to do this.
49
+
- Sourcebot will index itself to prepare for your search request.
50
+
- Map port 3000 between your machine and the docker image (`-p 3000:3000`).
Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you're only indexing public repositories select the `public_repo` scope; otherwise, select the `repo` scope.
53
+
## Configuring Sourcebot
62
54
63
-
You'll need to pass this PAT each time you run Sourcebot, so we recommend adding it as an environment variable. In this guide, we'll add the Github PAT as an environment variable called `GITHUB_TOKEN`:
64
-
```sh
65
-
export GITHUB_TOKEN=<your-token-here>
66
-
```
55
+
Sourcebot supports indexing and searching through public and private repositories hosted on
<imgsrc="https://gitlab.com/favicon.ico"width="16"height="16" />GitLab, and
61
+
<imgsrc="https://bitbucket.org/favicon.ico"width="16"height="16" /> BitBucket. This section will guide you through configuring the repositories that Sourcebot indexes.
67
62
68
-
If you'd like to persist this environment variable across shell sessions, please add this line to your shell config file (ex. `~/.bashrc`, `~/.bash_profile`, etc)
69
-
63
+
1. Create a new folder on your machine that stores your configs and `.sourcebot` cache, and navigate into it:
64
+
```
65
+
mkdir sourcebot_workspace
66
+
cd sourcebot_workspace
67
+
```
70
68
71
-
</details>
69
+
2. Create a new config following the [configuration schema](https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json) to specify which repositories Sourcebot should index. For example to index Sourcebot itself:
Two things should happen: (1) a `.sourcebot` directory will be created containing the mirror repositories and indexes, and (2) you will see output similar to:
125
+
TODO
124
126
125
-
```sh
126
-
INFO spawned: 'node-server' with pid 10
127
-
INFO spawned: 'zoekt-indexserver' with pid 11
128
-
INFO spawned: 'zoekt-webserver' with pid 12
129
-
run [zoekt-mirror-github -dest /data/.sourcebot/repos -delete -org <org>]
130
-
...
131
-
INFO success: node-server entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
132
-
INFO success: zoekt-indexserver entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
133
-
INFO success: zoekt-webserver entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
134
-
```
127
+
</details>
128
+
</div>
135
129
136
-
zoekt will now index your repositories (at `HEAD`). By default, it will re-index existing repositories every hour, and discover new repositories every 24 hours.
137
130
138
-
4. Go to `http://localhost:3000` - once an index has been created, you can start searching.
131
+
## Build from source
132
+
>[!NOTE]
133
+
>You don't need to build Sourcebot in order to use it! If you'd just like to use Sourcebot, please read [how to configure Sourcebot](#configuring-sourcebot).
139
134
140
-
## Building Sourcebot
135
+
If you'd like to make changes to Sourcebot you'll need to build from source:
141
136
142
137
1. Install <ahref="https://go.dev/doc/install"><imgsrc="https://go.dev/favicon.ico"width="16"height="16"> go</a> and <ahref="https://nodejs.org/"><imgsrc="https://nodejs.org/favicon.ico"width="16"height="16"> NodeJS</a>. Note that a NodeJS version of at least `21.1.0` is required.
143
138
@@ -167,7 +162,7 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules`
167
162
{
168
163
"Type": "github",
169
164
"GitHubOrg": "TaqlaAI",
170
-
"Name": "^sourcebot$"
165
+
"Name": "sourcebot"
171
166
}
172
167
]
173
168
}
@@ -216,14 +211,15 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules`
216
211
217
212
## Telemetry
218
213
219
-
By default, Sourcebot collects anonymized usage data through [PostHog](https://posthog.com/) to help us improve the performance and reliability of our tool. We do not collect or transmit [any information related to your codebase](https://github.com/search?q=repo:TaqlaAI/sourcebot++captureEvent&type=code). All events are [sanitized](https://github.com/TaqlaAI/sourcebot/blob/main/src/app/posthogProvider.tsx) to ensure that no sensitive or identifying details leave your machine. 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 :)
214
+
By default, Sourcebot collects anonymized usage data through [PostHog](https://posthog.com/) to help us improve the performance and reliability of our tool. We do not collect or transmit [any information related to your codebase](https://github.com/search?q=repo:TaqlaAI/sourcebot++captureEvent&type=code). In addition, all events are [sanitized](https://github.com/TaqlaAI/sourcebot/blob/main/src/app/posthogProvider.tsx) to ensure that no sensitive or identifying details leave your machine. 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 :)
220
215
221
216
If you'd like to disable all telemetry, you can do so by setting the environment variable `SOURCEBOT_TELEMETRY_DISABLED` to `1`in the docker run command:
222
-
```sh
223
-
docker run -e SOURCEBOT_TELEMETRY_DISABLED=1 /* additional args */ ghcr.io/taqlaai/sourcebot:main
224
-
```
225
217
226
-
Or if you are building locally, add the following to your [.env](./.env) file:
218
+
<pre>
219
+
docker run -e <b>SOURCEBOT_TELEMETRY_DISABLED=1</b> /* additional args */ ghcr.io/taqlaai/sourcebot:main
220
+
</pre>
221
+
222
+
Or if you are [building locally](#building-sourcebot), add the following to your [.env](./.env) file:
0 commit comments