Getting Started

Getting started with Convox is easy. The instructions below guide you through:

This guide takes around 30 minutes to go from zero to your first production deployment.

Sign Up

First, sign up for Convox Console, a web UI for managing your Organizations, Integrations and Racks.

Create an Organization

Next, set up your organization. All the Racks and integrations you set up for this organization are only visible to you. Later you can invite members of your team and assign them roles that control what they can access.

Connect an AWS Account

Next, click the Setup button then Connect an AWS account, and give Convox an AWS access key. This grants Convox access and permission to help manage resources in your AWS account.

See AWS Integration for more details.

Launch your private PaaS

Next, click on the Add Rack button, followed by Install New in the top navigation bar. Enter a descriptive Rack name such as production if you plan to deploy production services, or development if this is for testing.

See Installing a Rack for more details.

Install the Convox CLI

The convox command line tool offers:

  • convox start - A single command to start your development environment
  • convox deploy - A single command to deploy your application to a Rack
  • convox rack update - A single command to deliver API and infrastructure improvements to your Rack

along with numerous other utilities that make building, configuring, scaling and securing your apps easy.

Click the Setup button then Connect the Convox CLI to get your API key.

Next, install the Convox CLI for your platform.

$ curl -Ls https://convox.com/install/osx.zip > /tmp/convox.zip
$ unzip /tmp/convox.zip -d /usr/local/bin

Finally, use the convox login command with your API key:

$ convox login
API Key:
Logged in successfully.

See Installing the Convox CLI and API Keys for more details.

Deploy to Convox

Clone a sample application

$ git clone https://github.com/convox-examples/rails5
$ cd rails5

Create an app in your Rack

Before deploying, create a new app in your Rack.

$ convox apps create

Convox infers the app name from the current directory name. If you’d like to specify another name use convox apps create <name> and specify --app <name> to each of the following commands.

Wait for the underlying components to be created by watching for the app status to change to running:

$ convox apps info

Deploy the application

$ convox deploy

Continue to watch convox apps info to find the load balancer hostnames for the application.

$ convox apps info

When a load balancer is first created it can take 5-10 minutes for its hostname to become available in DNS.

Next Steps

Now that you’ve deployed your first application you can:

Or you can easily uninstall everything you just experimented with.