Skip to main content

Getting started

A 5 minute intro on how to create an account and start a sample generator.

Sign-up​

Sign in with your existing identity provider. In enterprise environments, your administrators may need to approve sharing basic profile information (primarily your email address), which we use as your unique identifier and notification target.

We currently support Microsoft and Google identities. If needed, you can create accounts here:

Create an organization​

Chose your organization name. It needs to be globally unique.

You will be redirected to the organization settings page where you can get:

  • The Sixpack API url
  • Your certificate
  • Your private key
  • Your authorisation token

The private key is used for mTLS. The authorisation token is used getting access to your namespace within the Sixpack orchestration platform. Both are to be treated as secrets.

Start a sample generator​

All sample repositories are available at https://github.com/orgs/sixpack-dev/repositories.

Sample repositories:

JavaTypeScript
sixpack-sample-javasixpack-sample-typescript
sixpack-sample-java-springsixpack-sample-typescript-playwright
sixpack-sample-java-dynamic-supplier

Clone a sample repository:

git clone https://github.com/sixpack-dev/sixpack-sample-java.git

  • Download the Private key and Certificate from organization settings and place them into the config/ directory in the cloned repository.

  • Copy the authorisation token from the organization settings page.

  • Set these environment variables:

    • SIXPACK_ORGANIZATION - your organization name; when using a downloaded client certificate, use the organization value shown together with that certificate and token in the organization configuration UI
    • SIXPACK_AUTH_TOKEN - your organization's token
    • SIXPACK_CLIENT_CERT_PATH=config/generator.pem - path to certificate
    • SIXPACK_CLIENT_KEY_PATH=config/generator.key - path to private key
    • SIXPACK_ENVIRONMENT - any environment label (for example dev)
    • SIXPACK_URL=gen.sixpack.dev:443 - Sixpack endpoint

The client certificate, private key, and authorisation token are used together. The token does not replace the mTLS files.

  • Open the repository in an IDE

Run the sample:

Configure JDK 17+ in your IDE.

In pom.xml, set sixpack.sdk.version to your published/internal Java SDK version.

Run ExampleSupplier.

Your data generator should now be connected to the Sixpack platform and already pre-generating datasets.

Play around​

You can play around, try to request some data and see how it works and read further here...