diff --git a/docs/admin/access_control/index.mdx b/docs/admin/access_control/index.mdx index 522982169..87ffa9d59 100644 --- a/docs/admin/access_control/index.mdx +++ b/docs/admin/access_control/index.mdx @@ -1,5 +1,12 @@ # Access control + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + This feature is in Beta stage. > NOTE: This page refers to in-product permissions, which determine who can, for example, create a batch change, or who is a site admin. This is *not* the same as [repository permissions](/admin/permissions/), which enforces the same repository access on Sourcegraph as your code host. diff --git a/docs/admin/analytics.mdx b/docs/admin/analytics.mdx index de1e15da5..162ebcaff 100644 --- a/docs/admin/analytics.mdx +++ b/docs/admin/analytics.mdx @@ -1,5 +1,12 @@ # Analytics + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + The analytics section helps Sourcegraph administrators understand user engagement across the various Sourcegraph features, identify power users, and convey value to internal leaders. Introduced in version 3.42, the section includes analytics breakdowns for our most common features such as Batch Changes, Search Notebooks and search, while also providing basic user-level analytics. ## Data Visualizations diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx index 7bce17bf7..727539b26 100644 --- a/docs/admin/auth/index.mdx +++ b/docs/admin/auth/index.mdx @@ -1,5 +1,12 @@ # User authentication + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + In order to use a Sourcegraph instance, users need an account on the instance. Accounts are used to store settings and preferences, but also to identify a person to make decisions about repository visibility. For that, various authentication providers can be configured. Multiple options can be provided. diff --git a/docs/admin/code_hosts/aws_codecommit.mdx b/docs/admin/code_hosts/aws_codecommit.mdx index 5875fb8b1..20b087e6b 100644 --- a/docs/admin/code_hosts/aws_codecommit.mdx +++ b/docs/admin/code_hosts/aws_codecommit.mdx @@ -1,5 +1,12 @@ # AWS CodeCommit + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Site admins can sync Git repositories hosted on [AWS CodeCommit](https://aws.amazon.com/codecommit/) with Sourcegraph so that users can search and navigate the repositories. To connect AWS CodeCommit to Sourcegraph: diff --git a/docs/admin/code_hosts/azuredevops.mdx b/docs/admin/code_hosts/azuredevops.mdx index 3c976197e..ddaaa580a 100644 --- a/docs/admin/code_hosts/azuredevops.mdx +++ b/docs/admin/code_hosts/azuredevops.mdx @@ -1,5 +1,12 @@ # Azure DevOps + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Site admins can sync Git repositories hosted on [Azure DevOps](https://dev.azure.com) with Sourcegraph so that users can search and navigate the repositories. To connect Azure DevOps to Sourcegraph, create a personal access token from your user settings page by following the below steps: diff --git a/docs/admin/code_hosts/bitbucket_cloud.mdx b/docs/admin/code_hosts/bitbucket_cloud.mdx index 7703ddde5..a9f6f5bee 100644 --- a/docs/admin/code_hosts/bitbucket_cloud.mdx +++ b/docs/admin/code_hosts/bitbucket_cloud.mdx @@ -1,5 +1,12 @@ # Bitbucket Cloud + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Site admins can sync Git repositories hosted on [Bitbucket Cloud](https://bitbucket.org) with Sourcegraph so that users can search and navigate the repositories. To connect Bitbucket Cloud to Sourcegraph: diff --git a/docs/admin/code_hosts/bitbucket_server.mdx b/docs/admin/code_hosts/bitbucket_server.mdx index 5333a8b3f..a81081fc9 100644 --- a/docs/admin/code_hosts/bitbucket_server.mdx +++ b/docs/admin/code_hosts/bitbucket_server.mdx @@ -1,4 +1,11 @@ -# Bitbucket Server / Bitbucket Data Center +# Bitbucket Server/Bitbucket Data Center + + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + Site admins can sync Git repositories hosted on [Bitbucket Server](https://www.atlassian.com/software/bitbucket/server) or [Bitbucket Data Center](https://www.atlassian.com/enterprise/data-center/bitbucket) with Sourcegraph so that users can search and navigate their repositories. diff --git a/docs/admin/code_hosts/gerrit.mdx b/docs/admin/code_hosts/gerrit.mdx index 6fafc14dd..ce27b961a 100644 --- a/docs/admin/code_hosts/gerrit.mdx +++ b/docs/admin/code_hosts/gerrit.mdx @@ -1,15 +1,23 @@ # Gerrit - This feature is in beta and might change in the future. + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + +This feature is in beta and might change in the future. A Gerrit instance can be connected to Sourcegraph as follows: - [Gerrit](#gerrit) - [Configure Gerrit as a code host connection](#configure-gerrit-as-a-code-host-connection) + - [Clone using SSH](#clone-using-ssh) - [Add Gerrit as an authentication provider](#add-gerrit-as-an-authentication-provider) - [Have users authenticate their Sourcegraph accounts using their Gerrit HTTP credentials](#have-users-authenticate-their-sourcegraph-accounts-using-their-gerrit-http-credentials) - [Configuration](#configuration) - - [admin/external\_service/gerrit.schema.json](#adminexternal_servicegerritschemajson) + - [admin/code\_hosts/gerrit.schema.json](#admincode_hostsgerritschemajson) ## Configure Gerrit as a code host connection diff --git a/docs/admin/code_hosts/github.mdx b/docs/admin/code_hosts/github.mdx index 88ef1901e..adaeb00e2 100644 --- a/docs/admin/code_hosts/github.mdx +++ b/docs/admin/code_hosts/github.mdx @@ -110,7 +110,7 @@ Once public, App can be installed in additional namespaces either from Sourcegra 5. To sync repositories from this installation, click **Add connection** under your new installation. ### Configuring Multiple Private GitHub Apps for Sourcegraph -If you prefer not to make your GitHub App public and instead create separate private GitHub Apps for each organizations, users will need to authorize each GitHub App individually to ensure proper repository access and permissions syncing. This is because GitHub Apps have narrowly scoped permissions and do not share authentication across multiple installations. To streamline this process, users can go to `User Settings` > `Account Security` in Sourcegraph and connect all necessary GitHub Apps from there. Once authorized, Sourcegraph will use the user's GitHub identity to determine access across all configured GitHub Apps. +If you prefer not to make your GitHub App public and instead create separate private GitHub Apps for each organizations, users will need to authorize each GitHub App individually to ensure proper repository access and permissions syncing. This is because GitHub Apps have narrowly scoped permissions and do not share authentication across multiple installations. To streamline this process, users can go to `User Settings` > `Account Security` in Sourcegraph and connect all necessary GitHub Apps from there. Once authorized, Sourcegraph will use the user's GitHub identity to determine access across all configured GitHub Apps. For customers using GitHub Enterprise Cloud, an alternative approach is to create an Enterprise GitHub App, which can be installed across multiple organizations within an enterprise account while maintaining private visibility. More details on this approach can be found in [GitHub's documentation](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-your-enterprise-account/creating-github-apps-for-your-enterprise). diff --git a/docs/admin/code_hosts/gitolite.mdx b/docs/admin/code_hosts/gitolite.mdx index 097e5fee3..c5fd71490 100644 --- a/docs/admin/code_hosts/gitolite.mdx +++ b/docs/admin/code_hosts/gitolite.mdx @@ -1,5 +1,12 @@ # Gitolite + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + > NOTE: While it is possible to connect Gitolite repositories to Sourcegraph, we currently do not recommend it. If you have specific questions, please discuss with your account team. Site admins can link and sync Git repositories on [Gitolite](https://gitolite.com) with Sourcegraph so that users can search and navigate the repositories. diff --git a/docs/admin/code_hosts/index.mdx b/docs/admin/code_hosts/index.mdx index f9541f40a..a3370f644 100644 --- a/docs/admin/code_hosts/index.mdx +++ b/docs/admin/code_hosts/index.mdx @@ -1,5 +1,12 @@ # Code host connections + + [Enterprise Starter](/pricing/enterprise-starter) only supports GitHub. [Enterprise](/pricing/enterprise) supports all listed code hosts. + + Available via the Web app. + + + Sourcegraph Enterprise Starter supports only GitHub as a code host connection. Enterprise plan can connect to all supported code hosts listed on this page. Sourcegraph can sync repositories from code hosts and other similar services. We designate code hosts between Tier 1 and Tier 2 based on Sourcegraph's capabilities when used with those code hosts. diff --git a/docs/admin/code_hosts/non-git.mdx b/docs/admin/code_hosts/non-git.mdx index f3edd3e9c..47cc9901d 100644 --- a/docs/admin/code_hosts/non-git.mdx +++ b/docs/admin/code_hosts/non-git.mdx @@ -1,5 +1,12 @@ # Non-Git code hosts (Perforce, Mercurial, Subversion, raw text, etc.) + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Sourcegraph natively supports all Git-based Version Control Systems (VCSs) and code hosts. For non-Git code hosts, Sourcegraph provides a CLI tool called `src-expose` to periodically sync and continuously serve local directories as Git repositories over HTTP. >NOTE: If using Perforce, see the [Perforce repositories with Sourcegraph guide](/admin/repo/perforce). diff --git a/docs/admin/code_hosts/other.mdx b/docs/admin/code_hosts/other.mdx index 4956c88d9..98bdb04c8 100644 --- a/docs/admin/code_hosts/other.mdx +++ b/docs/admin/code_hosts/other.mdx @@ -1,5 +1,12 @@ # Other Git repository hosts + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Site admins can sync Git repositories on any Git repository host (by Git clone URL) with Sourcegraph so that users can search and navigate the repositories. Use this method only when your repository host is not named as a supported [code host](/admin/code_hosts/). To connect generic Git host to Sourcegraph: diff --git a/docs/admin/code_hosts/phabricator.mdx b/docs/admin/code_hosts/phabricator.mdx index 2a8491641..fdc50cc78 100644 --- a/docs/admin/code_hosts/phabricator.mdx +++ b/docs/admin/code_hosts/phabricator.mdx @@ -1,5 +1,12 @@ # Phabricator + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Site admins can associate Git repositories on [Phabricator](https://phabricator.org) with Sourcegraph so that users can jump to the Phabricator repository from Sourcegraph and use the [Phabricator extension](#native-extension) and [browser extension](/integration/browser_extension) with Phabricator. > ⚠️ NOTE: Sourcegraph support of Phabricator is limited ([learn more](/integration/phabricator)), and not expected to evolve due to the [announced](https://admin.phacility.com/phame/post/view/11/phacility_is_winding_down_operations/) cease of support for Phabricator. diff --git a/docs/admin/config/index.mdx b/docs/admin/config/index.mdx index 79771f170..66cc4af3e 100644 --- a/docs/admin/config/index.mdx +++ b/docs/admin/config/index.mdx @@ -1,5 +1,12 @@ # Configuring Sourcegraph + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + This page documents how to configure a Sourcegraph instance. For deployment configuration, please refer to the [relevant deployment docs for your deployment type](/admin/deploy/#deployment-types). - [Site configuration](/admin/config/site_config) diff --git a/docs/admin/deploy/index.mdx b/docs/admin/deploy/index.mdx index abe94deb2..b4e057ef3 100644 --- a/docs/admin/deploy/index.mdx +++ b/docs/admin/deploy/index.mdx @@ -1,5 +1,12 @@ # Deployment Overview + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Sourcegraph is a powerful code intelligence platform that can be deployed in various ways to suit your organization's needs. This guide will help you understand the available deployment options and choose the best one for your use case. ## Deployment types diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index 1d0a362a8..c968da15f 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -1,5 +1,12 @@ # Executors + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Executors are Sourcegraph's solution for running untrusted code in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: - [Automatically indexing a repository for precise code navigation](/code-search/code-navigation/auto_indexing) diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 4016848e4..8d66b22ff 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -1,5 +1,12 @@ # Administration + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Sourcegraph administration is primarily managed by site administrators, who are responsible for the deployment, management, and configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart). diff --git a/docs/admin/licensing/index.mdx b/docs/admin/licensing/index.mdx index 13270c363..121025253 100644 --- a/docs/admin/licensing/index.mdx +++ b/docs/admin/licensing/index.mdx @@ -1,5 +1,12 @@ # Licensing + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + Sourcegraph requires a valid license key to enable many of its more prominent features. License keys should not be shared across instances of Sourcegraph. If an additional license key is required for something like a dev environment, please [contact customer support](https://about.sourcegraph.com/contact) for an additional license key. diff --git a/docs/admin/observability/index.mdx b/docs/admin/observability/index.mdx index ce0c6ef4f..2d2309c84 100644 --- a/docs/admin/observability/index.mdx +++ b/docs/admin/observability/index.mdx @@ -1,5 +1,11 @@ # Observability + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + A key pillar of production readiness is the ability to observe, monitor, and analyze the health and state of the system. Sourcegraph is designed, and ships with, a number of observability tools and capabilities to meet enterprise production readiness criteria. diff --git a/docs/admin/permissions/index.mdx b/docs/admin/permissions/index.mdx index 5fcecf8aa..647f18cd5 100644 --- a/docs/admin/permissions/index.mdx +++ b/docs/admin/permissions/index.mdx @@ -1,5 +1,12 @@ # Permissions + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + > NOTE: This page refers to repository access permissions synced between Sourcegraph and your code host, which has also historically been referred to as "authorization", "repository permissions", and "code host permissions". This is *not* the same as [in-product permissions](/admin/access_control/), which determine who can, for example, create a batch change or who is a site admin. Sourcegraph can be configured to enforce the same access to repositories and underlying diff --git a/docs/admin/updates/index.mdx b/docs/admin/updates/index.mdx index 5fc29e551..eee05cf2c 100644 --- a/docs/admin/updates/index.mdx +++ b/docs/admin/updates/index.mdx @@ -1,4 +1,11 @@ -# Updating sourcegraph +# Updating Sourcegraph + + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + This page is intended as an entry point into Sourcegraph versioning, upgrades, and the `migrator` service which manages our database schemas. Here we'll cover general concepts and direct you toward relevant operations pages.