Prerequisites
Requirements for the developer flow—deploying to your own GitHub account and servers.
Standard flow doesn't need this. If you're using Omaship's managed hosting, we handle everything. These prerequisites are only for developers who want Omaship to deploy to their own infrastructure.
GitHub Requirements
- GitHub account — Personal or organization
- Install the Omaship GitHub App — Grants permission to create repos and workflows
When you connect your GitHub account, you authorize Omaship to:
- Create repositories in your account/org
- Set up GitHub Actions workflows
- Configure repository secrets
- Create pull requests for updates
Server Requirements
If bringing your own VPS:
- Ubuntu 22.04+ — Other Linux distros may work but are untested
- 2GB RAM minimum — 4GB recommended
- Docker capable — We'll install Docker during setup
- SSH access — Root or sudo user
- Public IP address — For DNS configuration
Recommended: Hetzner
Best price/performance for European hosting:
- CX22 (2 vCPU, 4GB RAM) — €4.85/month
- CAX11 (2 ARM cores, 4GB RAM) — €3.79/month
Domain Requirements
- A domain you control — You'll configure DNS records
- Access to DNS settings — At your registrar or DNS provider
See DNS Setup for the exact records needed.
Local Development (Optional)
To develop locally on your machine:
- Ruby 3.3+ — Use mise, rbenv, or asdf
- SQLite 3.35+ — Usually pre-installed
- Node.js 20+ — For asset compilation
# Clone your repo
git clone git@github.com:your-org/your-app.git
cd your-app
# Install dependencies
bundle install
# Setup database
rails db:setup
# Start the server
bin/dev