Rouic Platform
Login

Rouic Platform Documentation

Deploy applications, provision managed databases, and store files — all from a single self-hosted platform at system.rouic.com.

Quick Start

1

Get an API Token

Log in to the dashboard and navigate to API Tokens. Create a token with the deploy scope. You'll receive a token starting with rk_ that you'll use for all API calls.

2

Create a Project

Use the dashboard or the API to create a project. Provide a name, a URL-safe slug, and optionally a Git repository URL.

3

Configure Services

Each project has one or more services. A service maps to a Docker container. Configure ports, subdomains, environment variables, and resource limits.

4

Deploy

Trigger a deployment via the API, the dashboard, or a GitHub webhook. The platform clones your repo, builds a Docker image, and performs a blue-green deploy with zero downtime.

Platform Overview

Rouic Platform is a self-hosted Platform-as-a-Service (PaaS) that runs on your own infrastructure. It provides a complete stack for deploying and running web applications.

App Deployment

  • Git-based deployments from any repository
  • Automatic Docker builds with custom Dockerfiles
  • Blue-green deployments for zero downtime
  • Auto SSL via Traefik reverse proxy
  • Preview deployments for pull requests
  • GitHub webhooks for push-to-deploy
  • Rollbacks to any previous deployment

Managed Databases

  • MySQL 8.0 with full SQL support
  • PostgreSQL 16 with advanced features
  • Redis 7 for caching and queues
  • Automatic connection strings
  • Built-in query browser
  • Scheduled backups and restores

Object Storage

  • S3-compatible API (MinIO)
  • Create and manage buckets
  • Access policies (public/private)
  • Presigned URLs for uploads/downloads
  • CORS configuration
  • Works with any S3 SDK

Scaling & Functions

  • Auto-scaling based on CPU/memory metrics
  • Scale-to-zero with instant wake on request
  • Scheduled cron functions (HTTP & shell)
  • Multi-replica load balancing via Traefik
  • Custom domains with automatic SSL
  • Configurable resource limits per service

Security & Monitoring

  • WAF with rate limiting and IP rules
  • Encrypted environment variables (AES-256-GCM)
  • API tokens with scoped permissions
  • Alert rules with email, Slack, Discord, webhook
  • Full metrics, deployment logs, and audit history
  • Scheduled database backups with retention

Rouic CLI

Deploy and manage projects from your terminal. Install globally via npm:

npm i -g rouic
rouic loginAuthenticate with your API token
rouic linkLink current directory to a project
rouic deployTrigger a deployment
rouic deploy -fDeploy and stream build logs
rouic logs -fStream latest deployment logs
rouic env lsList environment variables
rouic env pullDownload env vars to .env.local
rouic env add KEYAdd an environment variable
rouic projects lsList all your projects
rouic whoamiShow authenticated user

Explore the Docs

🚀

Deploying Apps

Step-by-step guide to deploying any application. Dockerfiles, environment variables, custom domains, and more.

🗄

Databases

Provision MySQL, PostgreSQL, or Redis instances. Connection strings, backups, and best practices.

📦

Object Storage

S3-compatible file storage. Create buckets, upload files, and generate presigned URLs.

⚖

Auto-Scaling

Configure auto-scaling rules, scale-to-zero, and monitor replica counts in real time.

⏰

Scheduled Functions

Run cron jobs as HTTP requests or shell commands on a schedule. Monitor execution and failures.

🌐

Custom Domains

Add custom domains with automatic SSL. DNS setup, Cloudflare integration, and primary domain configuration.

🔔

Alerts & Monitoring

Set up metric and event alerts with email, Slack, Discord, or webhook notifications.

🔌

API Reference

Complete REST API documentation with authentication, endpoints, and request/response examples.

🤖

AI Integration

Structured guide for AI models like Claude and GPT to autonomously deploy applications.

📄

OpenAPI Spec

Machine-readable API specification. Import into Postman, Swagger UI, or use with code generators.

Base URL

All API requests and dashboard access use the following base URL:

https://system.rouic.com

API endpoints are prefixed with /api/v1. For example, the deploy endpoint is at https://system.rouic.com/api/v1/deploy.