Skip to content

User Guide

This guide covers day-to-day usage of Rack Gateway from both the command line and web interface.

If you’re new to Rack Gateway, start with these guides:

  1. Install the CLI - Download and set up the command-line tool
  2. Login to your gateway - Authenticate with OAuth
  3. Explore the Web UI - Discover the admin interface

CLI Guide

The rack-gateway CLI is your primary interface for running Convox commands through the gateway.

Web UI Guide

The web interface provides admin functionality and self-service features.

TaskHow To
Deploy an apprack-gateway deploy -a myapp
View logsrack-gateway logs -a myapp -f
Run a commandrack-gateway run web "rake task" -a myapp
Check statusrack-gateway ps -a myapp
Switch environmentsrack-gateway switch staging
TaskWhere
Add a userWeb UI → Users → Create User
Change rolesWeb UI → Users → Edit User
View audit logsWeb UI → Audit Logs
Create API tokenWeb UI → API Tokens → Create
Configure MFAWeb UI → Settings → Security

Your role determines what you can do:

RoleCapabilities
ViewerRead-only: list apps, view logs, see builds
OpsViewer + restart apps, manage processes
DeployerOps + create builds, promote releases
AdminFull access including user management

See RBAC Overview for detailed permissions.