Skip to content
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/admin/deploy/docker-compose/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ set -euxo pipefail
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.3.9104'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.6.2535'
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/home/ec2-user/deploy-sourcegraph-docker'
DOCKER_COMPOSE_VERSION='1.29.2'
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-compose/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ set -euxo pipefail
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.3.9104'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.6.2535'
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/root/deploy-sourcegraph-docker'
DOCKER_COMPOSE_VERSION='1.29.2'
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-compose/digitalocean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ set -euxo pipefail
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.3.9104'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.6.2535'
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/root/deploy-sourcegraph-docker'
DOCKER_DATA_ROOT='/mnt/docker-data'
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-compose/google_cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ set -euxo pipefail
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.3.9104'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION='v5.6.2535'
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
# IMPORTANT: DO NOT MAKE ANY CHANGES FROM THIS POINT ONWARD
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/root/deploy-sourcegraph-docker'
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-compose/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Continue with the following steps *after* you have created a public or private c

```bash
# Specify the version you want to install
export SOURCEGRAPH_VERSION="v5.3.9104"
export SOURCEGRAPH_VERSION="v5.6.2535"
# Check out the selected version for use, in a new branch called "release"
git checkout $SOURCEGRAPH_VERSION -b release
```
Expand Down
8 changes: 4 additions & 4 deletions docs/admin/deploy/docker-compose/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This document describes the process to update a Docker Compose Sourcegraph insta

A [standard upgrade](/admin/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead.

If you've [configured Docker Compose with a release branch](/admin/deploy/docker-compose/#step-1-prepare-the-deployment-repository), please merge the upstream release tag for the next minor version into your `release` branch. In the following example, the release branch is being upgraded to v3.43.2.
If you've [configured Docker Compose with a release branch](/admin/deploy/docker-compose/#step-1-prepare-the-deployment-repository), please merge the upstream release tag for the next minor version into your `release` branch. In the following example, the release branch is being upgraded to v5.6.2535.

```sh
# first, checkout the release branch
Expand All @@ -17,16 +17,16 @@ git checkout release
git fetch upstream
# merge the upstream release tag into your release branch
git checkout release
git merge v3.43.2
git merge v5.6.2535
```

#### Address any merge conflicts you might have

For each conflict, you need to reconcile any customizations you made with the updates from the new version. Use the information you gathered earlier from the change log and changes list to interpret the merge conflict and to ensure that it doesn't over-write your customizations. You may need to update your customizations to accommodate the new version.

> NOTE: If you have made no changes or only very minimal changes to your configuration, you can also ask git to always select incoming changes in the event of merge conflicts. In the following example merges will be accepted from the upstream version v3.43.2:
> NOTE: If you have made no changes or only very minimal changes to your configuration, you can also ask git to always select incoming changes in the event of merge conflicts. In the following example merges will be accepted from the upstream version v5.6.2535:
>
> `git merge -X theirs v3.43.2`
> `git merge -X theirs v5.6.2535`
>
> If you do this, make sure your configuration is correct before proceeding because it may have made changes to your docker-compose YAML file.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-single-container/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This tutorial shows you how to deploy [single-container Sourcegraph with Docker]
- usermod -a -G docker ec2-user

# Install and run Sourcegraph. Restart the container upon subsequent reboots
- [ sh, -c, 'docker run -d --publish 80:7080 --publish 443:7080 --publish 127.0.0.1:3370:3370 --restart unless-stopped --volume /home/ec2-user/.sourcegraph/config:/etc/sourcegraph --volume /home/ec2-user/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.3.9104' ]
- [ sh, -c, 'docker run -d --publish 80:7080 --publish 443:7080 --publish 127.0.0.1:3370:3370 --restart unless-stopped --volume /home/ec2-user/.sourcegraph/config:/etc/sourcegraph --volume /home/ec2-user/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.6.2535' ]
```

- Select **Next: ...** until you get to the **Configure Security Group** page. Then add the following rules:
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-single-container/digitalocean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This tutorial shows you how to deploy [single-container Sourcegraph with Docker]
1. Run the Sourcegraph Docker image as a daemon:

```
docker run -d --publish 80:7080 --publish 443:7443 --restart unless-stopped --volume /root/.sourcegraph/config:/etc/sourcegraph --volume /root/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.3.9104
docker run -d --publish 80:7080 --publish 443:7443 --restart unless-stopped --volume /root/.sourcegraph/config:/etc/sourcegraph --volume /root/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.6.2535
```
1. Navigate to the droplet's IP address to finish initializing Sourcegraph. If you have configured a
DNS entry for the IP, configure `externalURL` to reflect that.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/docker-single-container/google_cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This tutorial shows you how to deploy [single-container Sourcegraph with Docker]
sudo apt-get install -y docker-ce
mkdir -p /root/.sourcegraph/config
mkdir -p /root/.sourcegraph/data
docker run -d --publish 80:7080 --publish 443:7443 --restart unless-stopped --volume /root/.sourcegraph/config:/etc/sourcegraph --volume /root/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.3.9104
docker run -d --publish 80:7080 --publish 443:7443 --restart unless-stopped --volume /root/.sourcegraph/config:/etc/sourcegraph --volume /root/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.6.2535
```

- Create your VM, then navigate to its public IP address.
Expand Down
10 changes: 5 additions & 5 deletions docs/admin/deploy/docker-single-container/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ docker run
--publish 7080:7080 --publish 127.0.0.1:3370:3370 --rm
--volume ~/.sourcegraph/config:/etc/sourcegraph
--volume ~/.sourcegraph/data:/var/opt/sourcegraph
sourcegraph/server:5.3.9104
sourcegraph/server:5.6.2535
```

Once the server is ready (logo is displayed in the terminal), navigate to the hostname or IP address on port `7080`. Create the admin account, then you'll be guided through setting up Sourcegraph for code searching and navigation.
Expand Down Expand Up @@ -46,7 +46,7 @@ For example, to mount a `.gitconfig`, create a file `/mnt/sourcegraph/config/git
Alternatively you can create a new Docker image which inherits from Sourcegraph and then mutates the environment:

```dockerfile
FROM sourcegraph/server:5.3.9104
FROM sourcegraph/server:5.6.2535

COPY gitconfig /etc/gitconfig
COPY ssh /root/.ssh
Expand Down Expand Up @@ -87,7 +87,7 @@ This is required to [collect debug data](/admin/pprof).
The docker run command for single-container Sourcegraph needs an additional publish flag to expose the debug port:

```sh
$ docker run --publish 7080:7080 --publish 127.0.0.1:3370:3370 --publish 127.0.0.1:6060:6060 --rm --volume ~/.sourcegraph/config:/etc/sourcegraph --volume ~/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.3.9104
$ docker run --publish 7080:7080 --publish 127.0.0.1:3370:3370 --publish 127.0.0.1:6060:6060 --rm --volume ~/.sourcegraph/config:/etc/sourcegraph --volume ~/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:5.6.2535
```

If Sourcegraph is deployed to a remote server, then access via an SSH tunnel using a tool
Expand All @@ -105,7 +105,7 @@ Add the following to your docker run command:
```sh
$ docker run [...]
-e (YOUR CODE)
sourcegraph/server:5.3.9104
sourcegraph/server:5.6.2535
```

## Operation
Expand Down Expand Up @@ -254,7 +254,7 @@ Sourcegraph can be **tested** on Windows 10 using roughly the same steps provide
1. [Install Docker for Windows](https://docs.docker.com/docker-for-windows/install/)
2. Using a command prompt, follow the same [installation steps provided above](#install-sourcegraph-with-docker) but remove the `--volume` arguments. For example by pasting this:

<pre class="pre-wrap"><code>docker run<span class="virtual-br"></span> --publish 7080:7080 --publish 127.0.0.1:3370:3370 --rm<span class="virtual-br"></span> sourcegraph/server:5.3.9104</code></pre>
<pre class="pre-wrap"><code>docker run<span class="virtual-br"></span> --publish 7080:7080 --publish 127.0.0.1:3370:3370 --rm<span class="virtual-br"></span> sourcegraph/server:5.6.2535</code></pre>

### Low resource environments

Expand Down
16 changes: 8 additions & 8 deletions docs/admin/deploy/kubernetes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ $ helm repo add sourcegraph https://helm.sourcegraph.com/release
Install the Sourcegraph chart using default values:

```sh
$ helm install --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm install --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```

Sourcegraph should now be available via the address set. Browsing to the url should now provide access to the Sourcegraph UI to create the initial administrator account.
Expand All @@ -79,7 +79,7 @@ Example overrides can be found in the [examples](https://github.com/sourcegraph/

Providing the override file to Helm is done with the inclusion of the values flag and the name of the file:
```sh
$ helm upgrade --install --values ./override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm upgrade --install --values ./override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```
When making configuration changes, it's recommended to review the changes that will be applied—see [Reviewing Changes](#reviewing-changes).

Expand Down Expand Up @@ -515,7 +515,7 @@ The override file includes a [BackendConfig] CRD. This is necessary to instruct
**Step 2:** – Install the chart

```sh
$ helm upgrade --install --values ./override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm upgrade --install --values ./override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```

It will take around 10 minutes for the load balancer to be fully ready, you may check on the status and obtain the load balancer IP using the following command:
Expand Down Expand Up @@ -636,7 +636,7 @@ storageClass:
**Step 2:** – Install the chart

```sh
$ helm upgrade --install --values ./override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm upgrade --install --values ./override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```

It will take some time for the load balancer to be fully ready, use the following to check on the status and obtain the load balancer address (once available):
Expand Down Expand Up @@ -723,7 +723,7 @@ storageClass:
**Step 2:** – Install the chart

```sh
$ helm upgrade --install --values ./override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm upgrade --install --values ./override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```

It will take some time for the load balancer to be fully ready, you can check on the status and obtain the load balancer address (when ready) using:
Expand Down Expand Up @@ -809,7 +809,7 @@ storageClass:
**Step 2:** – Install the chart

```sh
$ helm upgrade --install --values ./override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm upgrade --install --values ./override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```

It may take some time before your ingress is up and ready to proceed. Depending on how your Ingress Controller works, you may be able to check on its status and obtain the public address of your Ingress using:
Expand Down Expand Up @@ -909,7 +909,7 @@ $ helm repo update sourcegraph
**Step 4:** Install the new version:

```sh
$ helm upgrade --install -f override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
$ helm upgrade --install -f override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
```

**Step 5:** Verify the installation has started:
Expand Down Expand Up @@ -975,7 +975,7 @@ $ helm upgrade --install -n <your namespace> --set "migrator.args={upgrade,--fro

**Example:**
```sh
$ helm upgrade --install -n sourcegraph --set "migrator.args={upgrade,--from=3.41.0,--to=4.5.1}" sourcegraph-migrator sourcegraph/sourcegraph-migrator --version 5.3.9104
$ helm upgrade --install -n sourcegraph --set "migrator.args={upgrade,--from=3.41.0,--to=4.5.1}" sourcegraph-migrator sourcegraph/sourcegraph-migrator --version 5.6.2535
Release "sourcegraph-migrator" has been upgraded. Happy Helming!
NAME: sourcegraph-migrator
LAST DEPLOYED: Tue Mar 7 18:23:56 2023
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/kubernetes/kustomize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ See the [docs on reference repository](/admin/deploy/repositories) for detailed
# Recommended: replace the URL with your private fork
$ git clone https://github.com/sourcegraph/deploy-sourcegraph-k8s.git
$ cd deploy-sourcegraph-k8s
$ git checkout v5.3.9104 && git checkout -b release
$ git checkout v5.6.2535 && git checkout -b release
```

### **Step 2**: Set up a directory for your instance
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/machine-images/gce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ SSH into the VM as user `sourcegraph` and run the following command:

```bash
# Please update the version number according to the upgrade notes
helm upgrade -i -f /home/sourcegraph/deploy/install/override.yaml --version 5.3.9104 sourcegraph sourcegraph/sourcegraph
helm upgrade -i -f /home/sourcegraph/deploy/install/override.yaml --version 5.6.2535 sourcegraph sourcegraph/sourcegraph
# Note: /home/sourcegraph/deploy/install/override.yaml is the override file for your instance size
```

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/deploy/repositories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ You can now deploy using your private copy of the repository you've just created

Before you can upgrade Sourcegraph, you will first update your private copy with the upstream branch, and then merge the upstream release tag for the next minor version into your release branch.

In the following example, the release branch is being upgraded to v5.3.9104.
In the following example, the release branch is being upgraded to v5.6.2535.

```bash
export YOUR_RELEASE_BRANCH=release-$SG_DEPLOY_VERSION
Expand All @@ -72,7 +72,7 @@ git checkout $YOUR_RELEASE_BRANCH
git fetch upstream
# merge the upstream release tag into your release branch
git checkout $YOUR_RELEASE_BRANCH
git merge v5.3.9104
git merge v5.6.2535
```

A [standard upgrade](/admin/updates#standard-upgrades) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](/admin/updates#multi-version-upgrades) instead.
4 changes: 2 additions & 2 deletions docs/admin/external_services/postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ docker run [...]
-e CODEINTEL_PGPASSWORD=secret
-e CODEINTEL_PGDATABASE=sourcegraph-codeintel
-e CODEINTEL_PGSSLMODE=require
sourcegraph/server:5.3.9104
sourcegraph/server:5.6.2535
```

### Docker Compose
Expand Down Expand Up @@ -148,7 +148,7 @@ When [PgBouncer] is used, we need to include `statement_cache_mode=describe` in

Add the following to your `docker run` command:

<pre class="pre-wrap start-sourcegraph-command"><code>docker run [...]<span class="virtual-br"></span> -e PGDATASOURCE="postgres://username:[email protected]:5432/sg?statement_cache_mode=describe"<span class="virtual-br"></span> -e CODEINSIGHTS_PGDATASOURCE="postgres://username:[email protected]:5432/sg?statement_cache_mode=describe"<span class="virtual-br"></span> sourcegraph/server:5.3.9104</code></pre>
<pre class="pre-wrap start-sourcegraph-command"><code>docker run [...]<span class="virtual-br"></span> -e PGDATASOURCE="postgres://username:[email protected]:5432/sg?statement_cache_mode=describe"<span class="virtual-br"></span> -e CODEINSIGHTS_PGDATASOURCE="postgres://username:[email protected]:5432/sg?statement_cache_mode=describe"<span class="virtual-br"></span> sourcegraph/server:5.6.2535</code></pre>

### Docker Compose

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/external_services/redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ or follow the [IANA specification for Redis URLs](https://www.iana.org/assignmen
```
docker run [...]
-e REDIS_ENDPOINT=redis.mycompany.org:6379
sourcegraph/server:5.3.9104
sourcegraph/server:5.6.2535
```

> NOTE: On Mac/Windows, if trying to connect to a Redis server on the same host machine, remember that Sourcegraph is running inside a Docker container inside of the Docker virtual machine. You may need to specify your actual machine IP address and not `localhost` or `127.0.0.1` as that refers to the Docker VM itself.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/http_https_configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ docker container run \
\
--volume ~/.sourcegraph/config:/etc/sourcegraph \
--volume ~/.sourcegraph/data:/var/opt/sourcegraph \
sourcegraph/server:5.3.9104
sourcegraph/server:5.6.2535
```

### Sourcegraph Cluster (Kubernetes)
Expand Down
3 changes: 2 additions & 1 deletion docs/admin/ssl_https_self_signed_cert_nginx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Configuring NGINX with a self-signed certificate to support SSL requires:
- [3. Adding SSL support to NGINX](#3-adding-ssl-support-to-nginx)
- [4. Changing the Sourcegraph container to listen on port 443](#4-changing-the-sourcegraph-container-to-listen-on-port-443)
- [5. Getting the self-signed certificate to be trusted (valid) on external instances](#5-getting-the-self-signed-certificate-to-be-trusted-valid-on-external-instances)
- [Getting the self-signed cert trusted on other developer machines](#getting-the-self-signed-cert-trusted-on-other-developer-machines)
- [Next steps](#next-steps)

## 1. Installing mkcert
Expand Down Expand Up @@ -91,7 +92,7 @@ docker container run \
\
--volume ~/.sourcegraph/config:/etc/sourcegraph \
--volume ~/.sourcegraph/data:/var/opt/sourcegraph \
sourcegraph/server:5.3.9104
sourcegraph/server:5.6.2535
```

> NOTE: We recommend removing `--publish 7080:7080` as it's not needed and traffic sent to that port is un-encrypted.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/updates/grpc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Set the environment variable `GRPC_ENABLED="false"` on the `zoekt-indexserver` c
env:
- name: GRPC_ENABLED
value: 'false'
image: docker.io/sourcegraph/search-indexer:5.2.0
image: docker.io/sourcegraph/search-indexer:5.6.2535
```

_zoekt-indexserver can’t read from Sourcegraph’s site configuration, so we can only use environment variables to communicate this setting._
Expand Down
Loading