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
3 changes: 1 addition & 2 deletions docs/admin/auth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ order:
use the [OpenID Connect provider](#openid-connect).
- If you wish to use LDAP and cannot use the GitHub/GitLab OAuth provider as described above, or if
you wish to use another authentication mechanism that is not yet supported, please [contact
us](https://github.com/sourcegraph/sourcegraph/issues/new?template=feature_request) (we respond
promptly).
us](https://sourcegraph.com/contact)

Most users will use only one auth provider, but you can use multiple auth providers if desired to
enable sign-in via multiple services. Identities from different providers will be mapped to a
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/saml/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Error prefetching SAML service provider metadata

> NOTE: Email or NameID changes in the identity provider are not automatically reflected in Sourcegraph. Admins may manually update a users email via the admin interface at `https://example-sourcegraph.com/users/<user>/settings/emails`, or remove the user and recreate a new account.
>
> Work is planned to support SCIM on SAML auth providers, which should automate this process. ([tracking issue](https://github.com/sourcegraph/sourcegraph/issues/22732))
> Work is planned to support SCIM on SAML auth providers, which should automate this process.

### How to control user sign-up and sign-in

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/beta_and_experimental_features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Sourcegraph often beta tests major features before we make them generally availa

Exposing beta and experimental features gives you an opportunity to try our newest features sooner.

In return, your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new/choose), email it directly to [[email protected]](mailto:[email protected]), or use the in-app feedback modal.
In return, your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can email us directly to [[email protected]](mailto:[email protected]).

## Both beta and experimental features

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code_hosts/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ There are four fields for configuring which repositories are mirrored/synchroniz

- [`repos`](/admin/code_hosts/github#repos)A list of repositories in `owner/name` format. The order determines the order in which we sync repository metadata and is safe to change.
- [`orgs`](/admin/code_hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned).
- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only). See [this issue](https://github.com/sourcegraph/sourcegraph/issues/2562) for ongoing work to address this limitation.
- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only).
- [`exclude`](/admin/code_hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields.

## Rate limits
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/config/advanced_config_file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ When you upgrade Sourcegraph, you should do the following to ensure your configu

It is essential to follow the above steps after **every** Sourcegraph version update, because we only guarantee migrations remain valid across two minor versions. If you fail to apply a migration and later upgrade Sourcegraph twice more, you may effectively "skip" an important migration.

We're planning to improve this by having Sourcegraph notify you as a site admin when you should do the above, since today it is not actually required in most upgrades. See https://github.com/sourcegraph/sourcegraph/issues/4650 for details. In the meantime, we will do our best to communicate when this is needed to you through the changelog.
We're planning to improve this by having Sourcegraph notify you as a site admin when you should do the above, since today it is not actually required in most upgrades. In the meantime, we will do our best to communicate when this is needed to you through the changelog.

## Kubernetes ConfigMap

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/config/batch_changes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ You may encounter this error when publishing changesets to GitHub:

In addition to their normal API rate limits, GitHub also has an internal _content creation_ limit (also called [secondary rate limit](https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-secondary-rate-limits)), which is an [intentional](https://github.com/cli/cli/issues/4801#issuecomment-1029207971) restriction on the platform to combat abuse by automated actors. At the time of writing, the specifics of this limit remain undocumented, due largely to the fact that it is dynamically determined (see [this GitHub issue](https://github.com/cli/cli/issues/4801)). However, the behavior of the limit is that it only permits a fixed number of resources to be created per minute and per hour, and exceeding this limit triggers a temporary hour-long suspension during which time no additional resources of this type can be created.

Presently, Batch Changes does not automatically work around this limit feature request tracked [here](https://github.com/sourcegraph/sourcegraph/issues/44631). The current guidance if you do encounter this issue is to wait an hour and then try again, setting a less frequent `rolloutWindows` rate until this issue is no longer encountered.
Presently, Batch Changes does not automatically work around this limit feature request. The current guidance if you do encounter this issue is to wait an hour and then try again, setting a less frequent `rolloutWindows` rate until this issue is no longer encountered.

### Rollout window object

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/deploy/docker-single-container/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker i

`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:{CURRENT_VERSION_NO_V}`

You now have a single server Sourcegraph container image running on Postgresql 16.
You now have a single server Sourcegraph container image running on Postgresql 16.


### Standard upgrades
Expand Down Expand Up @@ -271,7 +271,7 @@ The version of this Postgres container is dependent on the version of the instan

## Troubleshooting

If you get stuck or need help, [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new?&title=Improve+Sourcegraph+quickstart+guide), [tweet (@sourcegraph)](https://twitter.com/sourcegraph) or [email](mailto:support@sourcegraph.com?subject=Sourcegraph%20quickstart%20guide).
If you get stuck or need help, please reach out to [Sourcegraph support](https://help.sourcegraph.com/hc/en-us/requests/new).

### Mac Computers with Apple silicon

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/kubernetes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1107,7 +1107,7 @@ Some Persistent Volumes may be retained after the uninstall phase is complete. I
[AWS EBS CSI driver]: https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html
[NGINX Ingress Controller]: https://github.com/kubernetes/ingress-nginx
[Helm Changelog]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/CHANGELOG
[Sourcegraph Changelog]: https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG
[Sourcegraph Changelog]: https://sourcegraph.com/changelog
[Sourcegraph Migrator]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph-migrator
[Helm Diff]: https://github.com/databus23/helm-diff
[Secrets]: https://kubernetes.io/docs/concepts/configuration/secret/
2 changes: 1 addition & 1 deletion docs/admin/deploy/kubernetes/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrat

Execution will continue, but please report this, along with your operating
system, terminal, and any other details, to:
https://github.com/sourcegraph/sourcegraph/issues/new
https://sourcegraph.com/contact

✱ Sourcegraph migrator 4.5.1
👉 Migrating to v3.43 (step 1 of 3)
Expand Down
5 changes: 3 additions & 2 deletions docs/admin/deployment_best_practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ _It is possible to migrate your data to a Docker-Compose or Kubernetes deploymen

Only the latest versions of IDEs are generally supported, but most versions within a few months up-to-date generally work.

- VS Code: [https://github.com/sourcegraph/sourcegraph/tree/main/client/vscode](https://github.com/sourcegraph/sourcegraph/tree/main/client/vscode); we don't yet support VSCodium
- JetBrains IDEs: [https://github.com/sourcegraph/sourcegraph/tree/main/client/jetbrains](https://github.com/sourcegraph/sourcegraph/tree/main/client/jetbrains) – we mainly test the plugin with IntelliJ IDEA, but it should work with no issues in all JetBrains IDEs, including:
- VS Code
- Visual Studio
- JetBrains IDEs — we mainly test the plugin with IntelliJ IDEA, but it should work with no issues in all JetBrains IDEs, including:
- IntelliJ IDEA
- IntelliJ IDEA Community Edition
- PhpStorm
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/executors/deploy_executors_terraform.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ Next, you can test whether the number of executors rises and shrinks as load spi
## Upgrading executors

Upgrading executors is relatively uninvolved. Simply follow the instructions below.
Also, check the [changelog](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability.
Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability.

### **Step 1:** Update the source version of the terraform modules

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/external_services/postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ The first migration fails since it attempts to add `COMMENT`s to installed exten
failed to run migration for schema "frontend": failed upgrade migration 1528395834: ERROR: current transaction is aborted, commands ignored until end of transaction block (SQLSTATE 25P02)
```

In this case, locate the UP [migration 1528395834](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/migrations/frontend/1528395834_squashed_migrations.up.sql) and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/admin/how-to/dirty_database).
In this case, locate the UP migration 1528395834 and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/admin/how-to/dirty_database).

**Dropping the `sg_service` role**

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/how-to/dirty_database.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ If you're running into errors such as being unable to create a unique index due

- For Kubernetes: replace container args with `["add-log", "-db=<schema>", "-version=<version>"]`
- For Docker-compose: replace container args with `"add-log" "-db=<schema>" "-version=<version>"`
- For local development: run `sg add-log -db=<schema> -version=<version>` in a clone of [sourcegraph/sourcegraph](https://github.com/sourcegraph/sourcegraph)
- For local development: run `sg add-log -db=<schema> -version=<version>`

Adding this migration log entry indicates to future migrator and application instances that a complete application of the migration at that version has been run.

Expand Down
5 changes: 2 additions & 3 deletions docs/admin/how-to/dirty_database_pre_3_37.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following procedure requires that you are able to execute commands from insi
_These steps pertain to the frontend database (pgsql) and are meant as a quick read for admins familiar with sql and database administration, for more explanation and details see the [detailed steps to resolution](#detailed-steps-to-resolve) below._

1. **Check the schema version in `psql` using the following query: `SELECT * FROM schema_migrations;`. If it's dirty, note the migration's version number.**
2. **Find the up migration with that migration's version number in [https://github.com/sourcegraph/sourcegraph/tree/\<YOUR-SOURCEGRAPH-VERSION\>/migrations/frontend](https://github.com/sourcegraph/sourcegraph/tree/main/migrations/frontend), making sure to go to \<YOUR-SOURCEGRAPH-VERSION\>**
2. **Find the up migration with that migration's version number making sure to go to \<YOUR-SOURCEGRAPH-VERSION\>**
* _Note: migrations in this directory are specific to the `pgsql` frontend database, learn about other databases in the [detailed steps to resolution](#detailed-steps-to-resolve)_
3. **Run the code there explicitly.**
4. **Manually clear the dirty flag on the `schema_migrations` table.**
Expand Down Expand Up @@ -53,7 +53,7 @@ _Note: for codeintel the schema version table is called `codeintel_schema_migrat

Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `<version>_<description>.<up or down>.sql` and can be found [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/migrations) in subdirectories for the specific database. _Note frontend is the pgsql database_.

1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** [https://github.com/sourcegraph/sourcegraph/tree/\<YOUR-SOURCEGRAPH-VERSION\>/migrations](https://github.com/sourcegraph/sourcegraph/tree/main/migrations), making sure to go to \<YOUR-SOURCEGRAPH-VERSION\>
1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** making sure to go to \<YOUR-SOURCEGRAPH-VERSION\>

2. **Run the code from the identified migration _up_ file explicitly using the `psql` CLI:**
* It’s possible that one or more commands from the migration ran successfully already. In these cases you may need to run the sql transaction in pieces. For example if a migration file creates multiple indexes and one index already exists you'll need to manually run this transaction skipping that line or adding `IF NOT EXISTS` to the transaction.
Expand Down Expand Up @@ -96,4 +96,3 @@ Additionally Grafana will alert you of an index is in this state. _The Grafana a
## Further resources

* [Sourcegraph - Upgrading Sourcegraph to a new version](/admin/updates)
* [Migrations README](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/migrations/README) (Note some of the info contained here pertains to running Sourcegraphs development environment and should not be used on production instances)
2 changes: 1 addition & 1 deletion docs/admin/migration/3_30.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ The 3.30 release introduced a `pgsql` and `codeinteldb` base image change from d
This caused corruption in indexes that have collatable key columns (e.g. any index with a `text` column).
Read more about this [here](https://postgresql.verite.pro/blog/2018/08/27/glibc-upgrade.html).

After we found the root-cause of the [issues many customers were seeing](https://github.com/sourcegraph/sourcegraph/issues/23288), we cut [a patch release, 3.30.3](/technical-changelog#3-30-3), that reverted the images to be based on debian, buying us time to change the alpine based version of the images to [reindex affected indexes on startup, before accepting new connections](https://github.com/sourcegraph/sourcegraph/issues/23310).
After we found the root-cause of the issues many customers were seeing, we cut [a patch release, 3.30.3](/technical-changelog#3-30-3), that reverted the images to be based on debian, buying us time to change the alpine based version of the images to reindex affected indexes on startup, before accepting new connections.

However, this means that after fixing the corrupt indexes on the alpine images in the affected releases, upgrading to debian based images in 3.30.3 will cause index corruption again. For this reason, **do not upgrade to 3.30.3** after fixing corrupt Postgres indexes. Instead, [please upgrade directly to 3.31](/admin/migration/3_31).
4 changes: 1 addition & 3 deletions docs/admin/migration/opengrok.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ After you've set Sourcegraph up, it's time to share it with your organization. S
> - Code browsing: [URL to a code file page on your Sourcegraph instance]
>
> [Include screenshots of your Sourcegraph instance here]
>
> Post feedback at https://github.com/sourcegraph/sourcegraph [change if needed]

- Create an internal document based on the [Sourcegraph tour](/getting-started/tour), substituting links to and names of your organization's code. This explains how Sourcegraph helps developers perform common tasks better.
- Encourage installation of the [browser extension](/integration/browser_extension) to get Sourcegraph code navigation and search in your organization's existing code host.
Expand All @@ -106,4 +104,4 @@ After you've set Sourcegraph up, it's time to share it with your organization. S

If there are any blockers preventing your organization from switching to Sourcegraph, we'd love to hear from you so we can address them.

Let us know how we can help! [File an issue](https://github.com/sourcegraph/sourcegraph) with feedback/problems/questions, or [contact us directly](https://about.sourcegraph.com/contact).
Let us know how we can help! [Contact us directly](https://sourcegraph.com/contact).
Loading