Skip to main content

​
Step 1: Create an account

Navigate to cubecloud.dev, and create a new Cube Cloud account.

​
Step 2: Create a new Deployment

Click Create Deployment button. This is the first step in the deployment creation. Give it a name and select the cloud provider and region of your choice.
Cube Cloud Create Deployment Screen
Microsoft Azure is available on Enterprise plan. Contact us for details.

​
Step 3: Import Git repository

Next up, the second step in creating a Cube App from scratch in Cube Cloud is to click Import Git repository via SSH button.
Cube Cloud Upload Project Screen
Enter the SSH URL of your Git repository, and click Generate SSH key:
Getting SSH key from Cube Cloud
Copy the SSH key and add it to your hosted Git repository. Back in Cube Cloud, click Connect. After a connection is successfully established, you should see the next screen:
Getting webhook URL from Cube Cloud
Copy the Cube Cloud Git Webhook URL and add it your hosted Git repository’s webhooks. Ensure that the Git repository can push events which should trigger a build on Cube Cloud. Back in Cube Cloud, click Connect to test the webhook.

​
Webhook format

Cube recognizes push webhooks in the formats sent by GitLab, Bitbucket, and Azure DevOps out of the box, so you can usually point your repository’s native webhook integration at the webhook URL without any extra configuration. If your Git host does not send one of these formats (for example, AWS CodeCommit), or you want to trigger a sync from a CI/CD pipeline or manually, send a POST request to the webhook URL with the x-git-event: push header:
  • Use the full webhook URL exactly as shown in the UI — it includes the token query parameter that authenticates the request.
  • The x-git-event: push header is required. Requests that do not carry a recognized Git event are ignored: Cube responds with 204, does not pull the repository, and the request is not shown under recent webhook requests.
  • ref is optional and names the branch to sync (in the refs/heads/<branch> form). If omitted, the production branch configured for the deployment is used.
Response status codes:

​
Step 4: Connect your Database

Enter your credentials to connect to your database. Check the connecting to databases guide for more details.
Want to use a sample database instead? We also have a sample database where you can try out Cube Cloud:
Cube Cloud Setup Database Screen
In the UI it’ll look exactly like the image below.
Cube Cloud Setup Database Screen
If you run into issues here, make sure to allow the Cube Cloud IPs to access your database. This means you need to enable these IPs in your firewall. If you are using AWS, this would mean adding a security group with allowed IPs.

​
Step 5: Generate the Data Model

Step five in this case consists of generating data models. Start by selecting the database tables to generate the data models from, then hit Generate.
Cube Cloud Setup Database Screen
Cube Cloud will generate the data models and spin up your Cube deployment. With this, you’re done. You’ve created a Cube deployment, configured a database connection, and generated data models!
Cube Cloud Setup Database Screen
You’re ready for the last step, running queries in the Playground.

​
Step 6: Try out Cube Cloud

Now you can navigate to Playground to try out your queries or connect your application to the Cube Cloud API.
Cube Cloud Playground