Example CI/CD Configurations

To help you incorporate the Twingate Services and Clients in headless mode into your CI/CD pipelines, we've included some sample configurations in a public Github repository, which are included in our automated testing.

Github Actions

We've included a number of steps that you can incorporate into your own Github Actions.

  • The Service Key associated with the action is assumed to be configured as a secret accessible as secret.SERVICE_KEY.
  • The base operating system is Ubuntu. If you are unable to use Ubuntu as your base OS, note that the Linux Client may not be compatible with other distributions.

CircleCI

We've included three steps to install & start, test, and then stop the Twingate Client in headless mode.

  • The $SERVICE_KEY is base64 encoded due to a CircleCI requirement around variable storage and requires decoding before being passed to twingate setup.
  • $TEST_URL is configured as a Resource only accessible while Twingate is connected.
  • The base operating system is Ubuntu. If you are unable to use Ubuntu as your base OS, note that the Linux Client may not be compatible with other distributions.

Did this page help you?