Skip to content

MercuryWorkshop/scramjet

Repository files navigation


Warning

Scramjet is not currently production ready, DO NOT USE THIS AS THE MAIN OPTION IN YOUR SITE.

npm version

Scramjet is an experimental inteception based web proxy that aims to be the successor to Ultraviolet. It is designed with security, developer friendlyness, and performance in mind. Scramjet strives to have a clean, organized codebase to improve maintainability. Scramjet is made to evade internet censorship and bypass arbitrary web browser restrictions.

Supported Sites

Some of the popular websites that Scramjet supports include:

Development

Dependencies

  • Recent versions of node.js and pnpm
  • rustup
  • wasm-bindgen
  • wasm-opt

Building

  • Clone the repository with git clone --recursive https://github.com/MercuryWorkshop/scramjet
  • Then, install your dependencies with pnpm i
  • After, build the rewriter with pnpm rewriter:build
  • Finally, build Scramjet with pnpm build

Running Scramjet Locally

You can run the Scramjet dev server with the command

pnpm dev

Scramjet should now be running at localhost:1337 and should rebuild upon a file being changed (excluding the rewriter).

Documentation

See the current index of documentation here.