Meteor

[!WARNING] Meteor is in a very early stage of development. Mainstream site support is not guaranteed. You can see our roadmap here.

The modern interception proxy you've been waiting for.

Meteor is a web proxy powered by service workers that intercepts HTTP requests and routes them through a Wisp server using bare-mux.

Installation

Meteor is a client-side JavaScript library. You can install it in your application in one of two ways:

  import express from 'express'
  import { meteorPath } from '@z1g-project/meteor'
 
  const app = express()
  app.use("/meteor/", express.static(meteorPath)

  import Fastify from 'fastify'
  import fastifyStatic from '@fastify/static'
  import { meteorPath } from '@z1g-project/meteor'
 
  Fastify()
  .register(fastifyStatic, {
    root: meteorPath,
    prefix: '/meteor/'
  })

Usage

Once you have the scripts served, register your service worker and set your transport on your frontend.

if ('serviceWorker' in navigator) {
    const registration = await navigator.serviceWorker.register('/sw.js')
    BareMux.SetTransport(
      "EpxMod.EpoxyClient", // replace with your transport
      { wisp: `wss://wisp-server-here.com` } // replace with the url of your wisp server
    ) 
  })
}
 
// After a button click or other event:
window.location.href = __meteor$config.prefix + __meteor$config.codec.encode("https://example.com") // replace url with the (full) url you want to navigate to

More in-depth usage and configuration can be found in the Wiki.

Testing and development

Running pnpm demo will serve a basic UI to test Meteor, along with a dev server that watches for changes in the source code and re-builds accordingly.