Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.92 KB

SELF-HOSTING.md

File metadata and controls

40 lines (27 loc) · 1.92 KB
Raw

Self Hosting

Hypersonic can be self hosted for free.

License

  • Free usage is limited to one user.
  • More than one user requires a paid license.
  • It is based on the honor system.

Overview

Self hosting is easy. It requires only a few things:

  • A Hosting account: Free and low cost options work well, like Vercel, Railway, Netlify

  • A Postgres Database: There are free options, like Neon, Vercel, Supabase

  • Liveblocks: Storage and syncing is done via Liveblocks. They have a free account too.

  • OAuth credentials: The project uses Auth.js, and all providers are supported. An easy-to-setup option is GitHub or Google. For a full list of providers, see list of env vars

  • Sentry (optional): error tracking is managed with Sentry

  • Fathom analytics (optional): for analytics, create a Fathom account.

Setup

To setup using Vercel and Neon:

  1. Download or fork the project
  2. Create a new hosting project on Vercel
  3. Create a free Neon database
  4. Migrate the database DATABASE_URL=... pnpm prisma db push
  5. Create an OAuth provider account (ie Github, Google, etc)
  6. Configure environment variables in the hosting account
  7. Optional: Create a Sentry account
  8. Optional: Create a Fathom Analytics account

Updates

To deploy updates, sync your fork with git fetch upstream main or download the latest version with git pull and re-deploy.

It's that simple!