Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates the upgrade steps #97

Merged
merged 4 commits into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Major features and changes are noted here. To review all updates, see the

:::

Related: [Upgrade CodeGate](../how-to/install.md#upgrade-codegate)
Related: [Upgrade CodeGate](../how-to/install.mdx#upgrade-codegate)

- **Request type muxing** - 26 Feb, 2025\
Workspace model muxing now supports filtering based on chat and FIM request
Expand Down
28 changes: 19 additions & 9 deletions docs/how-to/install.md → docs/how-to/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@ description: Install and upgrade CodeGate using Docker
sidebar_position: 10
---

import DefaultRunCommand from '../partials/_default-run-command.md';

## Prerequisites

CodeGate is distributed as a Docker container. You need a container runtime like
Docker Desktop or Docker Engine. Podman and Podman Desktop are also supported.
Windows, macOS, and Linux operating systems are all supported with x86_64 and
arm64 (ARM and Apple Silicon) CPU architectures.

These instructions assume the `docker` CLI is available. If you use Podman,
replace `docker` with `podman` in all commands.
These instructions assume you have the `docker` CLI available. If you use
Podman, replace `docker` with `podman` in all commands.

## Run CodeGate

Expand All @@ -31,9 +33,7 @@ secured/local network, see
To download and run CodeGate with the recommended configuration for full
functionality:

```bash
docker run --name codegate -d -p 8989:8989 -p 9090:9090 -p 8990:8990 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
```
<DefaultRunCommand />

Parameter reference:

Expand Down Expand Up @@ -61,7 +61,7 @@ lost when you stop or restart CodeGate.

:::

### Alternative run commands {#examples}
### Alternative run commands \{#examples}

Run with minimal functionality for use with **Continue**, **aider**, or
**Cline** (omits the HTTP proxy port needed by Copilot):
Expand All @@ -78,7 +78,7 @@ docker run --name codegate -d -p 127.0.0.1:8989:8989 -p 127.0.0.1:9090:9090 -p 1
```

**Install a specific version:** starting with v0.1.4 you can optionally run a
specific version of CodeGate using sematic version tags:
specific version of CodeGate using semantic version tags:

- Patch version: `ghcr.io/stacklok/codegate:v0.1.15` (exact)
- Minor version: `ghcr.io/stacklok/codegate:v0.1` (latest v0.1.x release)
Expand Down Expand Up @@ -143,6 +143,8 @@ flag:
docker logs --follow codegate
```

To update the logging verbosity, see [Advanced configuration](./configure.md).

## Upgrade CodeGate

To upgrade CodeGate to the latest version, start by reviewing the
Expand All @@ -160,8 +162,16 @@ Stop and remove the current container:
docker rm --force codegate
```

Finally, launch the new version using the
[same `docker run` command](#recommended-settings) you used originally.
Re-launch with the new image:

<DefaultRunCommand />

:::note

If you customized your `docker run` command, use the same command you used
originally.

:::

## Manage the CodeGate container

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Follow one of the the quickstart guides to get up and running quickly:
- [Quickstart guide - Continue](./quickstart-continue.mdx) to integrate CodeGate
with the open source Continue extension, VS Code, and a local Ollama server

Review the [installation instructions](./how-to/install.md).
Review the [installation instructions](./how-to/install.mdx).

Learn more about CodeGate's features:

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/continue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ To use this provider, download your desired model file in GGUF format from the
Then copy it into the `/app/codegate_volume/models` directory in the CodeGate
container. To persist models between restarts, run CodeGate with a Docker volume
as shown in the
[recommended configuration](../how-to/install.md#recommended-settings).
[recommended configuration](../how-to/install.mdx#recommended-settings).

Example using huggingface-cli to download our recommended models for chat (at
least a 7B model is recommended for best results) and autocomplete (a 1.5B or 3B
Expand Down
1 change: 1 addition & 0 deletions docs/partials/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"extends": "../../.markdownlint.json",
"first-line-h1": false
}
3 changes: 3 additions & 0 deletions docs/partials/_default-run-command.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```bash
docker run --name codegate -d -p 8989:8989 -p 9090:9090 -p 8990:8990 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
```
5 changes: 2 additions & 3 deletions docs/quickstart-copilot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ slug: /quickstart

import useBaseUrl from '@docusaurus/useBaseUrl';
import ThemedImage from '@theme/ThemedImage';
import DefaultRunCommand from './partials/_default-run-command.md';

## Objective

Expand All @@ -34,9 +35,7 @@ Required software:

Run CodeGate using Docker:

```bash
docker run --name codegate -d -p 8989:8989 -p 9090:9090 -p 8990:8990 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
```
<DefaultRunCommand />

This pulls the latest CodeGate image from the GitHub Container Registry and
starts the container the background, with the required port bindings and a
Expand Down
Loading