Documentation

getting started

Deploy Your First App in 5 Minutes

Go from zero to a live app on the internet in just a few steps. No Docker knowledge required.

Runix makes deploying your app as simple as pushing code to GitHub. You don't need to know anything about servers, Docker, or infrastructure. Just point Runix at your code and it handles the rest.

You don't need Docker installed. Runix handles everything — it detects your language, generates the right configuration, builds your app, and puts it online.

What You'll Need#

  • A Runix account (free to start)
  • A project you want to deploy (any language — Node.js, Python, Go, Rust, Java, or even a static site)
  • A terminal (the built-in one on your computer works great)

You can also deploy entirely from the dashboard at runixcloud.dev/dashboard/new — no terminal or CLI needed. Skip to step 7 if you prefer the visual approach.

Step-by-Step#

1

Create your account

Head to runixcloud.dev and sign up. You can use your GitHub account (recommended — this lets Runix access your repos) or sign up with email.

2

Install the Runix CLI

Open your terminal and run this command. It downloads and installs the Runix command-line tool.

bash
curl -fsSL https://runixcloud.dev/install.sh | sh

This works on macOS and Linux. Windows users can use WSL (Windows Subsystem for Linux) or deploy from the dashboard instead.

3

Log in

Authenticate the CLI with your Runix account. This opens your browser to complete the login.

bash
runix login
4

Navigate to your project

In your terminal, go to the folder that contains your project code.

bash
cd my-project
5

Initialize Runix

This command looks at your project and creates a runix.yaml configuration file. Runix auto-detects your language and framework, so the defaults are usually correct.

bash
runix init

Here's an example of the runix.yaml file it creates:

runix.yaml
yaml
name: my-app
services:
  - name: api
    type: web-service
    repo: https://github.com/user/api
    branch: main
    env:
      PORT: "8080"
      NODE_ENV: production

  - name: db
    type: postgresql

You can edit this file to add environment variables, change the branch, or add more services like a database. But the defaults work great for most projects.

6

Deploy

One command to go live. Runix will detect your runtime, generate a Dockerfile using AI, build your app, and deploy it.

bash
runix deploy

You'll see output like this:

text
Detecting runtime... Node.js (Next.js)
Generating Dockerfile... done
Building image... done (23s)
Deploying to my-app-x7kf.runixcloud.dev... live!

Your app is running at:
  https://my-app-x7kf.runixcloud.dev
7

Open your app

Visit your live app in the browser with a single command:

bash
runix open

That's it! Your app is live on the internet with HTTPS, a free subdomain, and zero configuration.

Every push to your main branch on GitHub triggers a new deployment automatically. Just push your code and Runix takes care of the rest.


What's Next?#

  • Add a custom domain — point your own domain name at your app
  • Set up environment variables — store secrets and config safely
  • Add a database — Runix can provision PostgreSQL alongside your app
  • Explore the dashboard — monitor deployments, view logs, and manage your projects visually