Enabling GitHub Actions with MinIO Gateway for NAS storage

You can enable GitHub Actions on GitHub Enterprise Server and use MinIO Gateway for NAS storage to store artifacts generated by workflow runs.

Site administrators can enable GitHub Actions and configure enterprise settings.

In this article

Prerequisites

Warning: The only supported S3 storage providers are Amazon S3 and MinIO Gateway for NAS. Other S3 API-compatible storage providers are not supported. For more information on supported storage providers, see "Getting started with GitHub Actions for GitHub Enterprise Server."

Before enabling GitHub Actions, make sure you have completed the following steps:

  • To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from your GitHub Enterprise Server instance.

  • Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the MinIO documentation. GitHub Actions requires the following permissions for the access key that will access the bucket:

    • s3:PutObject
    • s3:GetObject
    • s3:ListBucketMultipartUploads
    • s3:ListMultipartUploadParts
    • s3:AbortMultipartUpload
    • s3:DeleteObject
    • s3:ListBucket
  • Review the hardware requirements for GitHub Actions. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

  • TLS must be configured for your GitHub Enterprise Server instance's domain. For more information, see "Configuring TLS."

    Note: We strongly recommend that you configure TLS on GitHub Enterprise Server with a certificate signed by a trusted authority. Although a self-signed certificate can work, extra configuration is required for your self-hosted runners, and it is not recommended for production environments.

  • If you have an HTTP Proxy Server configured on your GitHub Enterprise Server instance, you must add localhost and 127.0.0.1 to the HTTP Proxy Exclusion list. For more information on changing your proxy settings, see "Configuring an outbound web proxy server."

Enabling GitHub Actions with MinIO Gateway for NAS 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 Actions. Actions tab in the settings sidebar

  4. Select Enable GitHub Actions. Checkbox to Enable GitHub Actions

  5. Under "Artifact & Log Storage", select Amazon S3, and enter your storage bucket's details:

    • AWS Service URL: The URL to your MinIO service. For example, https://my-minio.example:9000.
    • AWS S3 Bucket: The name of your S3 bucket.
    • AWS S3 Access Key and AWS S3 Secret Key: The MINIO_ACCESS_KEY and MINIO_SECRET_KEY used for your MinIO instance. For more information, see the MinIO documentation.

    Radio button for selecting Amazon S3 Storage and fields for MinIO configuration

  6. Under "Artifact & Log Storage", select Force path style. Checkbox to Force path style

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

  8. Wait for the configuration run to complete.

Next steps

After the configuration run has successfully completed, GitHub Actions will be enabled on your GitHub Enterprise Server instance. For your next steps, such as managing GitHub Actions access permissions and adding self-hosted runners, return to "Getting started with GitHub Actions for GitHub Enterprise Server."

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.