| title | AWS one-click |
|---|
To learn more about Sourcegraph, check out Sourcegraph 101 and the tour of features using real-world examples.
This page describes how to launch a verified and pre-configured Sourcegraph instance in just ~10 minutes using our one-click CloudFormation template and standard AMIs.
Prefer manually installing on AWS yourself? See our AMI installation options or our script-install installation options.
- An AWS account (most regions are supported, see our Launcher below for a complete list)
- General familiarity with AWS
- An EC2 keypair for SSH access
- (optional) A Sourcegraph license to unlock features (view plans or learn how licenses work)
Using our wizard, a single EC2 instance will be created with the following:
- EBS root volume: 50GB
- EBS data volume: 500GB - your Sourcegraph data (code and search indices.)
- AWS Network Security Group
- The latest version of Sourcegraph
- (optional) DNS and TLS via AWS Load Balancer and AWS Certificate Manager
NOTE: The instance will launch in the default VPC. If your AWS user does not have a default VPC, or the option
Auto-assign public IPv4 addressis not enabled for a subnet within that VPC, please see our Manual AMI instructions instead.
The number of users and repositories you will use with Sourcegraph determines your instance size. If you fall between two sizes, choose the larger of the two.
Example: With 8,000 users with 80,000 repositories, your instance size would be L. If you have 1,000 users with 80,000 repositories, then size M.
| XS | S | M | L | XL | |
|---|---|---|---|---|---|
| Users | <= 500 | <= 1,000 | <= 5,000 | <= 10,000 | <= 20,000 |
| Repositories | <= 5,000 | <= 10,000 | <= 50,000 | <= 100,000 | <= 250,000 |
| Recommended Type | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.24xlarge |
| Minimum Type | m6a.2xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge |
NOTE: For security, please follow Amazon best practices and do not deploy Sourcegraph using your AWS account root user.
NOTE: By default the CloudFormation template will create standard EBS volumes. If you have special EBS volume encryption requirements, please see the AWS EBS Encryption guide and install Sourcegraph using our Manual AMI instructions instead.
Choose an AWS Region in the launcher below and click Launch Stack. When prompted, choose your SSH Keypair and Sourcegraph Instance Size per the chart above, then Create Stack.
us-east-2 (US East (Ohio)) us-east-1 (US East (N. Virginia)) us-west-1 (US West (N. California)) us-west-2 (US West (Oregon)) af-south-1 (Africa (Cape Town)) ap-east-1 (Asia Pacific (Hong Kong)) ap-southeast-3 (Asia Pacific (Jakarta)) ap-south-1 (Asia Pacific (Mumbai)) ap-northeast-2 (Asia Pacific (Seoul)) ap-southeast-1 (Asia Pacific (Singapore)) ap-southeast-2 (Asia Pacific (Sydney)) ap-northeast-1 (Asia Pacific (Tokyo)) ca-central-1 (Canada (Central)) eu-central-1 (Europe (Frankfurt) eu-west-1 (Europe (Ireland)) eu-west-2 (Europe (London) eu-south-1 (Europe (Milan)) eu-west-3 (Europe (Paris)) eu-north-1 (Europe (Stockholm)) me-south-1 (Middle East (Bahrain)) me-central-1 (Middle East (UAE)) sa-east-1 (South America (São Paulo))Problem? See our Troubleshooting guide
Find the URL of your Sourcegraph instance in the Outputs section of the AWS Stack. On first launch, Sourcegraph may take ~5 minutes to start and may display a 404 not found page temporarily.
By default Sourcegraph will be available over HTTP on the public internet. To secure it you should now perform the following:
- Configure DNS and HTTPS/TLS using an AWS Load Balancer and AWS Certificate Manager.
- Configure user authentication (SSO, SAML, OpenID Connect, etc.)
- Review the new Network Security Group to prevent access from the public internet and follow the principle of least privilege.
We strongly recommend you taking snapshots of the entire Sourcegraph data EBS volume on an automatic, scheduled basis. Only the Sourcegraph data volume (500G) needs to be backed up.
To restore from a backup, simply follow our upgrade instructions and skip directly to Step 2: Launch a new instance - choosing your desired Sourcegraph version and your backed up data volume.
Updates are released every month, and upgrading is a simple process: backup your instance, detach the Sourcegraph data volume, and start a new instance using the latest AMI with your data volume attached. For step-by-step instructions see here.
Sourcegraph comes with extensive built-in monitoring dashboards & the ability to configure alerts. Please see our monitoring guide for more information.
Feel free to reach out to support@sourcegraph.com if you have any questions.
Business support, training, Slack support, SLAs, and dedicated Technical Advisors are all available through Business and Enterprise plans.