Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 1.89 KB

README.md

File metadata and controls

41 lines (35 loc) · 1.89 KB

setup-cloudflare-warp

Tests

The Boostport/setup-cloudflare-warp action sets up Cloudflare WARP in your GitHub Actions workflow. It allows GitHub Actions workflows to access resources that are secured by Cloudflare Zero Trust.

Usage

This action currently only supports Linux. Contributions to support Microsoft Windows and macOS are welcome.

To use this action, generate a service token using these instructions and configure the action:

Example:

uses: Boostport/setup-cloudflare-warp@v1
with:
  organization: your-organization
  auth_client_id: ${{ secrets.CLOUDFLARE_AUTH_CLIENT_ID }}
  auth_client_secret: ${{ secrets.CLOUDFLARE_AUTH_CLIENT_SECRET }}

You can specify the version of Cloudflare WARP to install:

uses: Boostport/setup-cloudflare-warp@v1
with:
  version: 2023.1.133
  organization: your-organization
  auth_client_id: ${{ secrets.CLOUDFLARE_AUTH_CLIENT_ID }}
  auth_client_secret: ${{ secrets.CLOUDFLARE_AUTH_CLIENT_SECRET }}

Inputs

  • version - (optional) The version of Cloudflare WARP to install. Defaults to the latest version.
  • organization - (required) The name of your Cloudflare Zero Trust organization.
  • auth_client_id - (required) The service token client id.
  • auth_client_secret - (required) The service token client secret.
  • install_root_certificate - (optional) Whether to install the Cloudflare Zero Trust root certificate. Defaults to false. This is only required if TLS decryption is enabled in your Cloudflare Zero Trust organization. See documentation.

Disclaimer

This is not an official Cloudflare product nor is it endorsed by Cloudflare.