ti.sil/sourcebot
1
0
Fork 0
mirror of https://github.com/sourcebot-dev/sourcebot.git synced 2025-12-12 04:15:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Change docs to instruct using the 'latest' tag instead of 'main'. 'latest' will only be updated on new releases, and thus will point to a more stable commit of the project vs. 'main' (which may included features still in active development).

Browse source
This commit is contained in:
bkellam 2024-10-02 12:22:08 -07:00
parent 31f6d63fba
commit e9f2ca0aed
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -42,7 +42,7 @@ You can try out our public hosted demo [here](https://demo.sourcebot.dev/)!
Get started with a single docker command: Get started with a single docker command:
``` ```
docker run -p 3000:3000 --rm --name sourcebot ghcr.io/sourcebot-dev/sourcebot:main docker run -p 3000:3000 --rm --name sourcebot ghcr.io/sourcebot-dev/sourcebot:latest
``` ```
Navigate to `localhost:3000` to start searching the Sourcebot repo. Want to search your own repos? Checkout how to [configure Sourcebot](#configuring-sourcebot). Navigate to `localhost:3000` to start searching the Sourcebot repo. Want to search your own repos? Checkout how to [configure Sourcebot](#configuring-sourcebot).
@ -50,7 +50,7 @@ Navigate to `localhost:3000` to start searching the Sourcebot repo. Want to sear
<details> <details>
<summary>What does this command do?</summary> <summary>What does this command do?</summary>
- Pull and run the Sourcebot docker image from [ghcr.io/sourcebot-dev/sourcebot:main](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot). Make sure you have [docker installed](https://docs.docker.com/get-started/get-docker/). - Pull and run the Sourcebot docker image from [ghcr.io/sourcebot-dev/sourcebot:latest](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot). Make sure you have [docker installed](https://docs.docker.com/get-started/get-docker/).
- Read the repos listed in [default config](./default-config.json) and start indexing them. - Read the repos listed in [default config](./default-config.json) and start indexing them.
- Map port 3000 between your machine and the docker image. - Map port 3000 between your machine and the docker image.
- Starts the web server on port 3000. - Starts the web server on port 3000.
@ -91,13 +91,13 @@ Sourcebot supports indexing and searching through public and private repositorie
3. Run Sourcebot and point it to the new config you created with the `-e CONFIG_PATH` flag: 3. Run Sourcebot and point it to the new config you created with the `-e CONFIG_PATH` flag:
```sh ```sh
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e CONFIG_PATH=/data/my_config.json ghcr.io/sourcebot-dev/sourcebot:main docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e CONFIG_PATH=/data/my_config.json ghcr.io/sourcebot-dev/sourcebot:latest
``` ```
<details> <details>
<summary>What does this command do?</summary> <summary>What does this command do?</summary>
- Pull and run the Sourcebot docker image from [ghcr.io/sourcebot-dev/sourcebot:main](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot). - Pull and run the Sourcebot docker image from [ghcr.io/sourcebot-dev/sourcebot:latest](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot).
- Mount the current directory (`-v $(pwd):/data`) to allow Sourcebot to persist the `.sourcebot` cache. - Mount the current directory (`-v $(pwd):/data`) to allow Sourcebot to persist the `.sourcebot` cache.
- Mirrors (clones) llama.cpp at `HEAD` into `.sourcebot/github/ggerganov/llama.cpp`. - Mirrors (clones) llama.cpp at `HEAD` into `.sourcebot/github/ggerganov/llama.cpp`.
- Indexes llama.cpp into a .zoekt index file in `.sourcebot/index/`. - Indexes llama.cpp into a .zoekt index file in `.sourcebot/index/`.
@ -152,7 +152,7 @@ In order to index private repositories, you'll need to generate a GitHub Persona
You'll need to pass this PAT each time you run Sourcebot by setting the `GITHUB_TOKEN` environment variable: You'll need to pass this PAT each time you run Sourcebot by setting the `GITHUB_TOKEN` environment variable:
<pre> <pre>
docker run -p 3000:3000 --rm --name sourcebot -e <b>GITHUB_TOKEN=[your-github-token]</b> -e CONFIG_PATH=/data/my_config.json -v $(pwd):/data ghcr.io/sourcebot-dev/sourcebot:main docker run -p 3000:3000 --rm --name sourcebot -e <b>GITHUB_TOKEN=[your-github-token]</b> -e CONFIG_PATH=/data/my_config.json -v $(pwd):/data ghcr.io/sourcebot-dev/sourcebot:latest
</pre> </pre>
</details> </details>
@ -169,7 +169,7 @@ Generate a GitLab Personal Access Token (PAT) [here](https://gitlab.com/-/user_s
You'll need to pass this PAT each time you run Sourcebot by setting the `GITLAB_TOKEN` environment variable: You'll need to pass this PAT each time you run Sourcebot by setting the `GITLAB_TOKEN` environment variable:
<pre> <pre>
docker run -p 3000:3000 --rm --name sourcebot -e <b>GITLAB_TOKEN=[your-gitlab-token]</b> -e CONFIG_PATH=/data/my_config.json -v $(pwd):/data ghcr.io/sourcebot-dev/sourcebot:main docker run -p 3000:3000 --rm --name sourcebot -e <b>GITLAB_TOKEN=[your-gitlab-token]</b> -e CONFIG_PATH=/data/my_config.json -v $(pwd):/data ghcr.io/sourcebot-dev/sourcebot:latest
</pre> </pre>
</details> </details>
@ -258,7 +258,7 @@ By default, Sourcebot collects anonymized usage data through [PostHog](https://p
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: 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:
<pre> <pre>
docker run -e <b>SOURCEBOT_TELEMETRY_DISABLED=1</b> /* additional args */ ghcr.io/sourcebot-dev/sourcebot:main docker run -e <b>SOURCEBOT_TELEMETRY_DISABLED=1</b> /* additional args */ ghcr.io/sourcebot-dev/sourcebot:latest
</pre> </pre>
Or if you are [building locally](#build-from-source), create a `.env.local` file at the repository root with the following contents: Or if you are [building locally](#build-from-source), create a `.env.local` file at the repository root with the following contents: