Developer Documentation

onrenderr Quickstart Guide

Welcome to onrenderr! This documentation walks you through deploying your first Web Service, setting up environment variables, connecting a custom domain with automated SSL, and choosing the Sydney, Australia datacenter region.

Step 1: Connect your Git Repository

Log in to your onrenderr dashboard, select New + → Web Service, and link your GitHub or GitLab account. Choose the repository you wish to deploy.

Step 2: Configure Build & Start Commands (Node.js)

For a standard Node.js Express application, configure the service settings as follows:

Service Configuration

# Recommended settings for Node.js Web Services
Name: my-node-api
Region: Sydney (ap-southeast-2)
Branch: main
Build Command: npm install
Start Command: node server.js
Environment: Node 18 or 20 LTS

Step 3: Deploying Python (FastAPI / Django)

onrenderr natively supports Python applications via Uvicorn, Gunicorn, or WSGI servers:

# Python FastAPI configuration
Build Command: pip install -r requirements.txt
Start Command: uvicorn main:app --host 0.0.0.0 --port $PORT

Step 4: Deploying Docker Containers

If your repository includes a Dockerfile, onrenderr will automatically detect it and build your container image:

FROM golang:1.21-alpine AS builder
WORKDIR /app
COPY . .
RUN go build -o app .

FROM alpine:latest
COPY --from=builder /app/app .
CMD ["./app"]

Step 5: Selecting Australian Datacenter (Sydney)

In the Region dropdown menu, select Sydney (ap-southeast-2). This ensures all HTTP requests from users in Australia, New Zealand, and Oceania are served with ultra-low latency (<15ms).

Step 6: Managed PostgreSQL & Connection Strings

Provisioning a database generates an internal connection string automatically injected into your web service's environment variables:

# Internal Private Network Connection URI
DATABASE_URL=postgres://admin:secret@dpg-sydney-db:5432/app_db

Infrastructure as Code: onrenderr.yaml Specification

You can commit an onrenderr.yaml file into the root of your Git repository to automatically provision services, databases, and cron jobs together:

onrenderr.yaml

services:
  - type: web
    name: app-frontend
    env: node
    region: sydney
    buildCommand: npm run build
    startCommand: npm start
    envVars:
      - key: NODE_ENV
        value: production

databases:
  - name: app-db
    databaseName: production
    user: dbuser
    region: sydney

Onrenderr CLI Tool Reference

Manage services directly from your terminal using the open-source CLI:

# Install Onrenderr CLI globally via npm
npm install -g onrenderr-cli

# Log in to your onrenderr account
onrenderr login

# Trigger a manual deployment of current branch
onrenderr deploy --region sydney

# Tail live streaming deployment logs
onrenderr logs --follow --service my-node-api