Get Started in 3 Simple Steps

1

Sign Up & Install Your Rack

Get started with the Convox Console to set up your cloud infrastructure. This guide uses both the Console and CLI.

After creating your account:

  • At the first prompt, pick your organization name
  • From the sidebar, go to Integrations page and create a Runtime Integration for your cloud provider
  • From the sidebar, go to Racks page and install a rack with your new Runtime then follow the guided modal
2

Install CLI & Connect

Install the Convox CLI locally, then copy your login command from the Console Account page to connect your CLI.

Choose your operating system:

curl -L https://github.com/convox/convox/releases/latest/download/convox-linux -o /tmp/convox

sudo mv /tmp/convox /usr/local/bin/convox

sudo chmod 755 /usr/local/bin/convox
curl -L https://github.com/convox/convox/releases/latest/download/convox-macos -o /tmp/convox

sudo mv /tmp/convox /usr/local/bin/convox

sudo chmod 755 /usr/local/bin/convox

To connect your CLI:

  • Navigate to Account Settings in the upper left corner of the Console
  • Generate a new CLI token (this will give you the login command to paste)
convox login console.convox.com -t your-cli-key-from-console

You can use this command to check your installed rack and make sure everything is working:

convox racks

Need help with other CLI commands?

Common CLI Commands
3

Set Up Your Application

Start with a template that matches your technology stack, then adapt the scaffolding to deploy your own application.

Choose a template to get started:

Rails Node.js PHP Django Deno or Browse All Templates

Quick start with Node.js template:

git clone https://github.com/convox-examples/nodejs.git my-app

cd my-app && convox apps create

# Customize the app code and convox.yml for your needs
convox deploy

convox services

💡 Pro Tip:

Each template includes a convox.yml file that defines your app's services, resources, and configuration. Copy this scaffolding to your own project and customize it for your specific needs.

📖 Full convox.yml Configuration Guide
⚙️

Rack Parameters

Fine-tune your infrastructure with node types, scaling policies, and cloud-specific configurations.
🔄

CI/CD Workflows

Automate deployments with GitHub integration, review apps, and multi-environment promotion.
📈

Auto-Scaling

Configure horizontal scaling based on CPU, memory, or custom metrics like Datadog.
🗄️

Databases & Caches

Deploy PostgreSQL, Redis, MySQL, and more with managed or containerized resources.
⎈

Kubernetes Access

Direct kubectl access to your cluster for advanced debugging and custom resource management.
🔗

Service Discovery

Configure internal and external service communication with load balancers and networking.

Ready to get started?

Create Free Account View Documentation