1
0
mirror of synced 2025-12-22 11:26:57 -05:00
Files
docs/content/admin/packages/enabling-github-packages-with-minio.md
Mischa 2eb1afb103 Update enabling-github-packages-with-minio.md (#22538)
Add line break for markdown rendering in production docs

Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
2021-11-02 11:15:43 -07:00

3.2 KiB

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

{% warning %}

Warnings:

  • It is critical that you set the 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 on the public internet.
  • 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.product.product_location_enterprise %}, you need to prepare your MinIO storage bucket. To help you quickly set up a MinIO bucket and navigate MinIO's customization options, see the "Quickstart for configuring your MinIO storage bucket for {% data variables.product.prodname_registry %}."

Ensure your MinIO external storage access key ID and secret have these permissions:

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

Enabling {% data variables.product.prodname_registry %} with MinIO external storage

Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. Also, note that MinIO's object storage is compatible with the S3 API and you can enter MinIO's bucket details in place of AWS S3 details.

{% 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.

  2. Enter your MinIO storage bucket's details in the AWS storage settings.

    • AWS Service URL: The hosting URL for your MinIO bucket.
    • AWS S3 Bucket: The name of your S3-compatible MinIO bucket dedicated to {% data variables.product.prodname_registry %}.
    • AWS S3 Access Key and AWS S3 Secret Key: Enter the MinIO access key ID and secret key to access your bucket.

    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 %}