Skip to main content

Enabling GitHub Packages with AWS

Set up GitHub Packages with AWS as your external storage.

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. Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haz clic en .

    Captura de pantalla del icono de cohete para acceder a los ajustes administrativos

  2. Si todavía no está en la página "Administrador del sitio", en la esquina superior izquierda, haga clic en Administrador del sitio.

    Captura de pantalla del vínculo "Administrador del sitio"

  3. En la barra lateral de la izquierda, haga clic en Consola de administración . Pestaña Consola de administración en la barra lateral de la izquierda

  4. En la barra lateral de la izquierda, haga clic en Packages. Pestaña Packages en la barra lateral de la consola de administración

  5. En "GitHub Packages", seleccione Habilitar GitHub Packages. Casilla para habilitar GitHub Packages desde el menú de la consola de administración de la empresa

  6. 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 GitHub Packages.

    • 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

  7. En la barra lateral de la izquierda, haga clic en Guardar configuración.

    Captura de pantalla del botón para guardar los ajustes en la Consola de administración

    Nota: Al guardar la configuración en la Consola de administración se restablecen los servicios de sistema, lo que podría generar un tiempo de inactividad visible para el usuario.

  8. Espera que se complete la fase de configuración.

    Configurar tu instancia

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."