Everything you need to get Yield up and running.
Get Yield running in under five minutes.
Purchase from yieldhq.com and receive your license key instantly.
One command sets up Docker, PostgreSQL, Caddy, and Yield.
Follow the prompts, set your domain, and start working.
Step-by-step instructions for deploying Yield on your server.
Linux server (Ubuntu 22.04+ recommended)
2GB+ RAM minimum
Docker & Docker Compose
The installer handles everything automatically, but here is a breakdown of the steps:
Download and run the installer
curl -sL get.yieldhq.com | bash
Enter your license key when prompted
The installer validates your license key and configures the deployment.
Configure your domain
Point your DNS to the server and enter the domain. Caddy handles SSL automatically.
Docker Compose starts all services
The Yield ERP app, PostgreSQL database, and Caddy reverse proxy all spin up automatically.
Access your Yield instance
Navigate to your domain in a browser and log in with the credentials created during setup.
Key environment variables configured during installation:
| Variable | Description | Required |
|---|---|---|
DATABASE_CONNECTION_STRING |
PostgreSQL connection string | Yes |
YIELDHQ_LICENSE_KEY |
Your Yield license key | Yes |
YIELDHQ_DOMAIN |
Your domain (e.g. erp.yourcompany.com) | Yes |
FORCE_MIGRATIONS |
Auto-run database migrations on startup | No |
OAUTH_GOOGLE_CLIENT_ID |
Google OAuth client ID | No |
OAUTH_GOOGLE_CLIENT_SECRET |
Google OAuth client secret | No |
Customize Yield to fit your business needs.
Yield uses PostgreSQL as its database. The installer sets up a PostgreSQL container automatically.
To use an external PostgreSQL server, update the connection string in .env and remove the postgres service from docker-compose.yml.
Yield uses Caddy as a reverse proxy which automatically provisions and renews SSL certificates via Let's Encrypt.
YIELDHQ_DOMAIN to your domain in .env.
yielderp restart. Caddy handles the rest.
Allow users to sign in with their Google accounts.
https://your-domain.com/auth/google/callback.
OAUTH_GOOGLE_CLIENT_ID and OAUTH_GOOGLE_CLIENT_SECRET to your .env file.
yielderp restart.
Modules included in your license are activated automatically. To manage modules:
Manage your Yield instance from the command line.
yielderp status
Display service status and resource usage for all Yield containers.
yielderp logs [service]
View logs for a specific service. Services: erp, postgres, caddy.
yielderp backup
Create a full database backup. Backups are saved to the /backups directory.
yielderp restore <file>
Restore the database from a backup file.
yielderp update
Pull the latest version and restart all services.
yielderp health
Run a health check on all services and report their status.
yielderp config show
View the current configuration (sensitive values are masked).
yielderp restart
Restart all Yield services (ERP, PostgreSQL, Caddy).
How Yield is built and how the modules fit together.
Yield is built as a set of independent, composable modules. Each module handles a specific business domain (CRM, Sales, Inventory, etc.) and can be activated or deactivated without affecting others. Modules communicate through a shared data layer and event system, ensuring seamless integration while maintaining separation of concerns.
Every create, update, and delete across all modules is automatically logged with full before/after JSON snapshots, changed field tracking, user attribution, and timestamps. Soft deletes are detected and tracked separately. The audit log is stored in PostgreSQL with JSONB columns for efficient querying.
Yield includes a built-in MCP (Model Context Protocol) server that exposes every module as discoverable tools for AI agents. With the source code license, your team uses Claude to customize Yield by describing changes in plain English — Claude reads the AI docs, understands the architecture, and edits source code, compiles, tests, and deploys automatically.
Yield's MCP server exposes 40+ tools across all modules. Connect any AI assistant to interact with your ERP data.
$ claude mcp add --transport http yield \
https://erp.yourcompany.com/mcp
Endpoints: /mcp/sse (SSE) and /mcp/messages (HTTP POST)
Use Claude Code with the included AI documentation to customize any part of Yield.
$ claude "add a discount field to sales orders"
Modified 3 files, build succeeded, deployed ✓
Requires Source Code + AI Docs license ($9,999 one-time)
Our support team is ready to assist with installation, configuration, and beyond.