Quickstart

The fastest path is Docker Compose. You’ll have the router, API, and portal running locally against a Postgres container.

1. Clone and start

git clone https://github.com/getcoherence/openpartner.git
cd openpartner
cp .env.example .env
docker compose up -d

Wait for migrations to finish, then visit:

Portal: http://localhost:5173
API: http://localhost:8787
Click router: http://localhost:8788

2. First-run install

The first time you load the portal, you’ll hit the install wizard. Fill in:

You — your name + admin email.
Program — the public name partners will see, plus a support email.
Email delivery — Postmark or SMTP for sending magic links.

Once submitted, the install wizard creates the first admin and emails you a magic link.

3. Add a partner

From the admin dashboard, Partners → Invite. Drop in their email; they’ll get a magic link to claim the account.

4. Drop the SDK on your site

<script src="https://cdn.openpartner.dev/sdk/v1.js"></script>
<script>
  window.openpartner.init({ siteId: 'site_xxx' });
  window.openpartner.track();
</script>

When a user signs up, call identify():

window.openpartner.identify(user.id, { email: user.email });

When revenue happens, call event():

window.openpartner.event('subscription_created', { amount: 4900, currency: 'USD' });

5. Approve commissions and pay out

Commissions land in pending review by default. From the admin dashboard, you can approve or reject. Approved commissions become payable on the next payout run.

For Stripe Connect payouts, partners onboard through the portal — their account, their funds, your transfers.