1
0
mirror of synced 2025-12-23 11:54:18 -05:00
Files
docs/content/admin/packages/enabling-github-packages-with-aws.md
Joe Clark 74a679dc51 Make product variables for Enterprise translation-friendly (#31628)
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Evan Bonsignori <ebonsignori@github.com>
2022-10-17 18:54:05 +00:00

3.3 KiB

title, intro, versions, type, topics, shortTitle
title intro versions type topics shortTitle
Enabling GitHub Packages with AWS Set up {% data variables.product.prodname_registry %} with AWS as your external storage.
ghes
*
tutorial
Administrator
Enterprise
Packages
Packages
Enable Packages with AWS

{% warning %}

Warnings:

  • It is critical that you configure any restrictive access policies you need for your storage bucket, because {% data variables.product.company_short %} 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 {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_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 {% data variables.product.prodname_registry %}.

{% endwarning %}

Prerequisites

Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.location.product_location_enterprise %}, 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 {% data variables.product.prodname_registry %} with AWS external storage

{% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_site_admin_settings.packages-tab %} {% data reusables.package_registry.enable-enterprise-github-packages %}

{% ifversion ghes %}

  1. Under "Packages Storage", select Amazon S3 and enter your storage bucket's details:

    • AWS Service URL: The service URL for your bucket. For example, if your S3 bucket was created in the us-west-2 region, this value should be https://s3.us-west-2.amazonaws.com.

      For more information, see "AWS service endpoints" in the AWS documentation.

    • AWS S3 Bucket: The name of your S3 bucket dedicated to {% data variables.product.prodname_registry %}.

    • AWS S3 Access Key and AWS S3 Secret Key: The AWS access key ID and secret key to access your bucket.

      For more information on managing AWS access keys, see the "AWS Identity and Access Management Documentation."

    Entry boxes for your S3 AWS bucket's details {% endif %} {% data reusables.enterprise_management_console.save-settings %}

Next steps

{% data reusables.package_registry.next-steps-for-packages-enterprise-setup %}