​
Prerequisites

Before you move to production, you need to have the following:
  1. An active Flipt Cloud account. If you don’t have an account yet, request access here.
  2. An active GitHub account. If you don’t have an account yet, sign up on GitHub.
  3. A configured Flipt environment in Flipt Cloud. If you don’t have an environment yet, follow the getting started guide.
  4. Deployed Flipt instances in your infrastructure. If you don’t have Flipt instances yet, deploy Flipt Open Source.

​
Create an API Key

1

Login to Cloud

First, log in to the Flipt Cloud web interface. You can access the login page at https://flipt.cloud.
2

Navigate to your Environment

From the Flipt Cloud dashboard, find the environment you want to create an API key for and hover over the environment name.
3

Click on the Edit link

Click on the Edit link.Edit Environment
4

Create an API Key

Click on the Security tab and then click on the Create API Key button.Security
5

Name your API Key

Give your API a name to help you identify it later and click on the Create button.Name API KeyCopy the API key to your clipboard and save it in a secure location. You will not be able to access the API key after you leave this page.API Key Created

​
Configure a Client-Side SDK

Currently, Flipt Cloud only supports client-side SDKs for direct evaluation via the Flipt Cloud API.
For more information on the architecture of Flipt Cloud, see the architecture overview.
1

Install the SDK

Choose the SDK that matches your application’s language and install it. All client-side SDKs are documented here.
2

Configure the SDK

Configure the SDK with the API key you created in the previous step and set the following options:
  • URL: The URL of the Flipt Cloud API.
  • Authentication: The API key authentication method configured with the API key you created in the previous step.
  • (Optional) Namespace: The namespace to use for the SDK. (Default: default)
  • (Optional) Fetch Mode: Set to streaming to enable streaming mode. (Default: polling)
For example, here’s how you can configure the SDK for a Go application:
evaluationClient, _ := flipt.NewClient(
    flipt.WithURL("https://<environment>-<organization>.flipt.cloud"),
    flipt.WithClientTokenAuthentication(<api-key>),
    flipt.WithNamespace(<namespace>),
    flipt.WithFetchMode(flipt.FetchModeStreaming),
)
3

Use the SDK

That’s it! 🎉 You can now use the SDK to evaluate feature flags and configurations.

​
Scale and Configure Server-Side SDKs

As mentioned in the architecture overview, Flipt Cloud is designed to be used in conjunction with Flipt Open Source. This means that you can still use your existing Flipt instances and configurations while leveraging the security and user friendly features of Flipt Cloud. Here’s how you can configure your Flipt instances to use the Git repository data source and then use our server-side SDKs to evaluate feature flags within your infrastructure.
1

Configure the Flipt instances

Configure the Flipt instances to use the Git repository data source.As described in the Flipt Open Source storage documentation, you can configure the Flipt instances to use the Git repository data source.Here you can use the same repository and branch as you used when creating the Flipt Cloud environment.
storage:
type: git
git:
    repository: "https://github.com/<git-organization>/<git-repository>"
    ref: "main"
    poll_interval: "30s"
    authentication:
        token:
            access_token: <git-access-token>
2

Restart the Flipt instances

Restart the Flipt instances to apply the changes.
3

Install the SDK

Choose the SDK that matches your application’s language and install it. All server-side SDKs are documented here.
You can also use any of our OpenFeature SDKs or OpenFeature Remote Evaluation Protocol implementations to evaluate feature flags within your infrastructure.
4

Configure the SDK

Configure the SDK with the URL of your Flipt instance within your infrastructure.
  • URL: The URL of the Flipt instance.
For example, here’s how you can configure the OpenFeature SDK for a Go application:
provider := flipt.NewProvider(flipt.WithAddress("https://localhost:443")) // Replace with the URL of your Flipt instance
openfeature.SetProvider(provider)

client := openfeature.NewClient("my-app")
value, err := client.BooleanValue(context.Background(), "v2_enabled", false, openfeature.NewEvaluationContext(
    "tim@apple.com",
    map[string]interface{}{
        "favorite_color": "blue",
    },
))
5

Scale

That’s it! 🎉 You can now scale your feature flagging operations with Flipt Cloud and Flipt Open Source.All changes to the feature flags and configurations are automatically propagated to your Flipt instances within your infrastructure through the Git repository data source.

​
What’s Next?

You can now start using Flipt Cloud to scale your feature flagging operations. As your organization grows, check out some of our enterprise features including:

​
Questions?

If you have any questions or need further assistance, please ask in either our Discord channel or Flipt Community Discourse.