From e9f2ca0aedae16c5be65dc89285782774d68b671 Mon Sep 17 00:00:00 2001 From: bkellam Date: Wed, 2 Oct 2024 12:22:08 -0700 Subject: [PATCH] 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). --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7bc2df15..2ab2c105 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ You can try out our public hosted demo [here](https://demo.sourcebot.dev/)! 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). @@ -50,7 +50,7 @@ Navigate to `localhost:3000` to start searching the Sourcebot repo. Want to sear
What does this command do? -- 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. - Map port 3000 between your machine and the docker image. - 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: ```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 ```
What does this command do? - - 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. - Mirrors (clones) llama.cpp at `HEAD` into `.sourcebot/github/ggerganov/llama.cpp`. - 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:
-docker run -p 3000:3000 --rm --name sourcebot -e GITHUB_TOKEN=[your-github-token] -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 GITHUB_TOKEN=[your-github-token] -e CONFIG_PATH=/data/my_config.json -v $(pwd):/data ghcr.io/sourcebot-dev/sourcebot:latest
 
@@ -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:
-docker run -p 3000:3000 --rm --name sourcebot -e GITLAB_TOKEN=[your-gitlab-token] -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 GITLAB_TOKEN=[your-gitlab-token] -e CONFIG_PATH=/data/my_config.json -v $(pwd):/data ghcr.io/sourcebot-dev/sourcebot:latest
 
@@ -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:
-docker run -e SOURCEBOT_TELEMETRY_DISABLED=1 /* additional args */ ghcr.io/sourcebot-dev/sourcebot:main
+docker run -e SOURCEBOT_TELEMETRY_DISABLED=1 /* additional args */ ghcr.io/sourcebot-dev/sourcebot:latest
 
Or if you are [building locally](#build-from-source), create a `.env.local` file at the repository root with the following contents: