Quick Start

Welcome to Customary, your go-to platform for seamless code deployment. This guide will walk you through the process of deploying your code using our platform, making it as easy as possible for first-time users. Let’s get started!

First, sign in to our platform using your GitHub account. After signing in, click on the DEPLOYMENTS option from the side menu. This will allow us to access your repositories for deployment. Once you’re signed in, you’ll be prompted to select the repository you wish to prepare for deployment. This is the codebase that will be deployed on our servers.

Step 2: Choose Your Branch

Next, you’ll need to select the branch of your repository that you want us to monitor for deployment. This is a flexible feature - you can create multiple deployments for different branches such as staging and testing. Each deployment will monitor its respective branch and automatically update the deployment with each commit you make.

Step 3: Choose Your Runtime

Now it’s time to choose the runtime for your deployment. We currently support Django and Docker. If you select Django, our platform will automatically read your Django settings and prepare an appropriate environment for your code to run in, with no changes needed from you. If you select Docker, our platform will look for a “Dockerfile” in your repository and deploy it on our cluster. Remember to select the port of the Dockerfile to be exposed to the internet - we’ll handle the SSL certificate and expose that port on port 443.

Step 4: Name Your Deployment and Choose URL

Give your deployment a name - this will help you identify it later. You’ll also need to choose a URL where this deployment can be accessed. This will be the web address where your deployed code will be live.

Step 5: Select Instance Size

Choose the instance size for your deployment. This determines the amount of CPU and RAM provided to your deployment. This is important because it affects the performance of your deployed code. Choose a size that fits your needs.

Step 6: Create and Attach a Database

If your code requires a database, you can create and attach a PostgreSQL database to your deployment. You’ll need to provide a name for the database, choose a PostgreSQL version, and determine the storage size. Customary will then inject the database’s URL, username, and password into your environment for easy access.

Step 7: Attach a Storage Volume

Choose the size of the storage volume to attach to your deployment. This storage can be shared between deployments and is accessible at the mount point you select (e.g., /storage/). Unlike the regular deployment storage, this storage is highly available and persists between restarts and deployments, making it ideal for storing data that needs to persist.

Step 8: Deploy

Now you’re ready to deploy! Customary will take your code, package it, and prepare it for deployment. You will be redirected to your deployment’s build log where you can monitor the progress of the deployment.

Deployment Dashboard

Once your code is deployed, you can monitor and configure your deployments from your deployment dashboard. Most settings selected during the creation of the deployment can be edited here. It’s designed to be simple and self-explanatory, but if you have any questions, don’t hesitate to reach out to us.

Congratulations! You’ve now completed the quick start guide for Customary. We’re excited to see what you’ll build!