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:
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.
MFA Guide
Multi-factor authentication adds an extra layer of security to your account.
| Task | How To |
|---|---|
| Deploy an app | rack-gateway deploy -a myapp |
| View logs | rack-gateway logs -a myapp -f |
| Run a command | rack-gateway run web "rake task" -a myapp |
| Check status | rack-gateway ps -a myapp |
| Switch environments | rack-gateway switch staging |
| Task | Where |
|---|---|
| Add a user | Web UI → Users → Add User |
| Change roles | Web UI → Users → user’s actions → Edit User |
| View audit logs | Web UI → Audit Logs |
| Create API token | Web UI → API Tokens → Create Token |
| Configure MFA | Web UI → Settings → MFA Requirements |
Your role determines what you can do:
| Role | Capabilities |
|---|---|
| Viewer | Read-only: list apps, view logs, see builds |
| Ops | Viewer + restart apps, run and stop processes, read env vars |
| Deployer | Ops + deploy, change env vars, promote releases, own API tokens |
| Admin | Full access including users, settings and integrations |
See RBAC Overview for detailed permissions.
