Enabling GitHub Packages with AWS

Set up GitHub Packages with AWS as your external storage.

In this article

Warnings:

  • It is critical that you configure any restrictive access policies you need for your storage bucket, because GitHub does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessible to the public internet. For more information, see "Setting bucket and object access permissions" in the AWS Documentation.
  • We recommend using a dedicated bucket for GitHub Packages, separate from the bucket you use for GitHub Actions storage.
  • Make sure to configure the bucket you'll want to use in the future. We do not recommend changing your storage after you start using GitHub Packages.

Prerequisites

Before you can enable and configure GitHub Packages on your GitHub Enterprise Server instance, you need to prepare your AWS storage bucket. To prepare your AWS storage bucket, we recommend consulting the official AWS docs at AWS Documentation.

Ensure your AWS access key ID and secret have the following permissions:

  • s3:PutObject
  • s3:GetObject
  • s3:ListBucketMultipartUploads
  • s3:ListMultipartUploadParts
  • s3:AbortMultipartUpload
  • s3:DeleteObject
  • s3:ListBucket

Enabling GitHub Packages with AWS external storage

  1. From an administrative account on GitHub Enterprise Server, click in the upper-right corner of any page. Rocketship icon for accessing site admin settings

  2. In the left sidebar, click Management Console. Management Console tab in the left sidebar

  3. In the left sidebar, click Packages. Packages tab in management console sidebar

  4. Under "AWS Service URL", type the S3 endpoint URL for your bucket's region. AWS Service URL field

  5. Under "AWS S3 Bucket", type the name of the S3 bucket you want to use to store package artifacts. AWS S3 Bucket field

  6. Under "AWS S3 Access Key", type your access key for S3. AWS S3 Access Key field

  7. Under "AWS S3 Secret Key", type your secret key for S3. AWS S3 Secret Key field

  8. Under "AWS S3 Region", type your region for S3. AWS S3 Region field

  9. Under the left sidebar, click Save settings. The Save settings button in the Management Console

  10. Wait for the configuration run to complete.

Next steps

As a next step, you can customize which package ecosystems you would like to make available to end users on your GitHub Enterprise Server instance. For more information, see "Configuring package ecosystem support for your enterprise."

For an overview of getting started with GitHub Packages on GitHub, see "Getting started with GitHub Packages for your enterprise."

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.