⚡
Hypercast
Github
  • 🌠Overview
  • 💡Getting Started
  • 🔧Self Hosting
  • 🚀API
    • 🎨hypercast/client
    • ⚙️hypercast/server
Powered by GitBook
On this page
  • Creating your instance
  • Connecting to your instance

Self Hosting

Hypercast instances can be self-hosted in a matter of minutes using Cloudflare.

Hypercast runs on Cloudflare, so if you don't have an account, set one up first. You'll also need to install their CLI tool wrangler andl log in.

Creating your instance

This is all the code it takes to run a simple instance:

import { Operator } from 'hypercast/server'
export { Hypercast } from 'hypercast/server'
export default new Operator()

To deploy to Cloudflare, you'll also need a wrangler.toml config file.

name = "my-hypercast"
main = "src/index.ts"

account_id = 'abcdefg1234567'
compatibility_date = "2022-12-03"

[durable_objects]
  bindings = [
    { name = "hypercasts", class_name = "Hypercast" }
  ]

[[migrations]]
  tag = "init_hypercast"
  new_classes = ["Hypercast"]

With that, simply run wrangler publish.

Connecting to your instance

To connect a Hypercast client to your server instance, we'll need it's URL.

import { Operator, Hypercast } from 'hypercast/client'

const operator = new Operator('https://my-hypercast.org.workers.dev')

// or

const hypercast = new Hypercast(topic, 'https://my-hypercast.org.workers.dev')
PreviousGetting StartedNexthypercast/client

Last updated 2 years ago

🔧