Skip to content
Docs · Self-hosting

Self-hosting

Self-hosting and open source

Yomenie is open source under the MIT licence. Run your own copy on Cloudflare (a Worker, a Container, D1 and Email Sending), or locally without sign-in.

Updated

On this page

Yomenie is open source under the MIT licence. You can run your own copy, change it and build on it. The repository’s docs/ folder has the full guides: self-hosting.md, architecture.md, security.md and local-vs-production.md, plus CONTRIBUTING.md at the root. This page is the short version.

What you need

yomenie.us runs on Cloudflare, and the self-hosting guide follows the same setup:

Thing Why
A Cloudflare account with your domain on it One Worker serves your domain
Workers Paid plan Cloudflare Containers need it
Email Sending for a (sub)domain Sign-in and join emails
Node 24 and pnpm 12 Building
Docker, running Building the container image

The steps, in short

  1. Create two D1 databases: yomenie (accounts, join links, sessions) and yomenie-app (the app’s data).
  2. Point apps/edge/wrangler.jsonc at your account: account id, your hostnames, the database ids and your sender address. A few values (the sender, allowed origins, the site URL) are set in code; the guide lists them.
  3. Apply the migrations: pnpm exec wrangler d1 migrations apply yomenie --remote, in apps/edge.
  4. Set the vault key, which encrypts stored connection secrets: openssl rand -base64 32 | pnpm exec wrangler secret put VAULT_KEY. The app won’t start without it, and losing it loses every stored secret.
  5. Deploy: pnpm --filter @yomenie/edge run deploy, with Docker running.
  6. Create your workspace at https://<your-domain>/app/start, or keep sign-up closed and make one with node scripts/bootstrap.mjs --remote <slug> "<Name>" https://<your-domain>, which prints a one-use owner join link.

Check it with https://<your-domain>/api/health.

Sign-up settings

Plain Worker variables, changed with a config edit and a redeploy:

Variable Default Meaning
SIGNUP_MODE open open: anyone can create a workspace. invite: sign-ups paused, early-access list shown. closed: refused
MAX_COMPANIES 200 Workspaces in total
MAX_COMPANIES_PER_USER 3 Workspaces one person can create through sign-up
MAX_MEMBERS_PER_COMPANY 25 People in one workspace

Voice and video

Without extra setup, voice runs peer to peer and video is hidden. To turn on video, and the Cloudflare Realtime transport for voice, create a Realtime app in the Cloudflare dashboard and set the Worker secrets CF_REALTIME_APP_ID and CF_REALTIME_APP_TOKEN, then redeploy. /api/health reports whether it works.

Peer-to-peer voice has no TURN relay yet, so it may not connect on strict networks. Coming: TURN relay for strict networks, on the roadmap

Push notifications

Notifications always reach the in-app bell. To also push them to people’s devices, generate a VAPID key pair with pnpm --filter @yomenie/api exec web-push generate-vapid-keys and set the Worker secrets VAPID_PUBLIC_KEY, VAPID_PRIVATE_KEY and VAPID_SUBJECT (mailto: your address), then redeploy. /api/health then says "push":"on". Keep the pair: changing it makes every browser turn notifications on again.

Problem reports

People can report a problem from the app, and calls that go wrong report themselves (see Privacy). Set the Worker var REPORTS_BOARD to <workspace slug>/<board name> (a board in your own team’s workspace): every report then becomes a ticket there (one per call episode for automatic ones), and whoever is on that board’s team can open the full reports at /app/reports (for a workspace-wide board, its owners and admins). To give that to a different team in the same workspace, set REPORTS_TEAM to <workspace slug>/<team name>. Without it, reports are stored but nobody can open them. Reports are deleted after 30 days.

Running it locally

For development you don’t need Cloudflare at all:

pnpm install
pnpm dev

The web app runs on port 3000 and the API on 8787, with demo data and no sign-in: anyone who can reach it can act as anyone, so keep that setup on your own machine or a private network. Passwordless sign-in lives in the Cloudflare Worker; running it without Cloudflare isn’t built.

wrangler dev runs the whole stack locally, sign-in included; the self-hosting guide has the steps.

A polished, tested self-hosting path is on the roadmap. Coming: Self-hosting guide polish, on the roadmap