diff --git a/Makefile b/Makefile
index d3c5eac7..298cb5e5 100644
--- a/Makefile
+++ b/Makefile
@@ -11,6 +11,6 @@ zoekt:
go build -C vendor/zoekt -o $(PWD)/bin ./cmd/...
clean:
- rm -rf bin node_modules
+ rm -rf bin node_modules .next .sourcebot
.PHONY: bin
diff --git a/README.md b/README.md
index 55454dee..d12d525c 100644
--- a/README.md
+++ b/README.md
@@ -22,31 +22,79 @@ Sourcebot is a fast code indexing and search tool for your codebases. It is buil
## Using Docker
-0. [Install docker](https://docs.docker.com/get-started/get-docker/)
-1. Create a `config.json` file and list the repositories you want to index. For example, if we want to index all repositories in [vercel](https://github.com/vercel), we could use the following config:
+0. Install 
Docker
+
+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`:
```json
{
- "$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/zoekt-mirror.json",
- "Config": [
+ "$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
+ "Configs": [
{
"Type": "github",
- "GitHubOrg": "vercel"
+ "GitHubOrg": "TaqlaAI",
+ "Name": "^sourcebot$"
}
]
}
```
-Sourcebot also supports indexing [GitLab](#gitlab) & [BitBucket](#bitbucket). Checkout the [config schema](./schemas/zoekt-mirror.json) for a full list of available options.
+Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](./schemas/index.json) for a full list of available options.
-2. Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you are indexing public repositories only, you can select the `public_repo` scope, otherwise you will need the `repo` scope. ([GitLab](#gitlab) and [BitBucket](#bitbucket) instructions are below)
+2. Create a Personal Access Token (PAT) to authenticate with a code host(s):
-3. Launch the latest image from the [GitHub registry](https://github.com/TaqlaAI/sourcebot/pkgs/container/sourcebot):
+
+
+ 
GitHub
+
+ Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you are indexing public repositories only, you can select the `public_repo` scope, otherwise you will need the `repo` scope.
+
+
+
+
+ 
GitLab
+
+ TODO
+
+
+
+
+ 
BitBucket
+
+ TODO
+
+
+
+
+ GitHub
```sh
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITHUB_TOKEN= ghcr.io/taqlaai/sourcebot:main
```
+
+
+
+ GitLab
+
+```sh
+docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITLAB_TOKEN= ghcr.io/taqlaai/sourcebot:main
+```
+
+
+
+
+ BitBucket
+
+TODO
+
+
+
+
go and 
NodeJS
+
+1. Clone the repository with submodules:
+```sh
+git clone --recurse-submodules https://github.com/TaqlaAI/sourcebot.git
+```
+
+2. Run make to build zoekt and install dependencies:
+```sh
+cd sourcebot
+make
+```
+
+The zoekt binaries and web dependencies are placed into `bin` and `node_modules` respectively.
+
+3. Create a `config.json` file and list the repositories you want to index. The JSON schema defined in [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`:
+
+```json
+{
+ "$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
+ "Configs": [
+ {
+ "Type": "github",
+ "GitHubOrg": "TaqlaAI",
+ "Name": "^sourcebot$"
+ }
+ ]
+}
+```
+
+4. Create a Personal Access Token (PAT) to authenticate with a code host:
+
+
+
+ GitHub
+
+ Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you are indexing public repositories only, you can select the `public_repo` scope, otherwise you will need the `repo` scope.
+
+ Create a text file named `.github-token` in your home directory and paste the token in it. The file should look like:
+ ```sh
+ ghp_...
+ ```
+ zoekt will [read this file](https://github.com/TaqlaAI/zoekt/blob/6a5753692b46e669f851ab23211e756a3677185d/cmd/zoekt-mirror-github/main.go#L60) to authenticate with GitHub.
+
+
+
+ GitLab
+ TODO
+
+
+
+ BitBucket
+ TODO
+
+
+