> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/mercuryworkshop/scramjet/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to Scramjet

> A powerful interception-based web proxy for bypassing browser restrictions

# Introduction to Scramjet

Scramjet is an interception-based web proxy designed to bypass arbitrary web browser restrictions, support a wide range of sites, and act as middleware for open-source projects. It prioritizes security, developer friendliness, and performance.

## What is Scramjet?

Scramjet uses a service worker-based architecture to intercept and rewrite web traffic, allowing you to:

* Bypass web browser restrictions and filters
* Proxy popular websites including Google, YouTube, Discord, Reddit, and more
* Build privacy-focused web applications
* Create custom proxy solutions with full developer control

## Key features

<CardGroup cols={2}>
  <Card title="CAPTCHA support" icon="shield-check">
    Built-in support for CAPTCHAs on major sites like Google and YouTube
  </Card>

  <Card title="Wide site compatibility" icon="globe">
    Works with Twitter, Instagram, Spotify, Discord, Reddit, GeForce NOW, and more
  </Card>

  <Card title="Service worker architecture" icon="gear">
    Uses modern browser APIs for powerful request interception
  </Card>

  <Card title="Developer friendly" icon="code">
    Clean API with TypeScript support and comprehensive documentation
  </Card>

  <Card title="Flexible configuration" icon="sliders">
    Customize codecs, flags, and behavior to suit your needs
  </Card>

  <Card title="Performance optimized" icon="bolt">
    Efficient WASM-based rewriting for fast page loads
  </Card>
</CardGroup>

## Supported sites

Scramjet has been tested and works with:

* Google
* Twitter
* Instagram
* YouTube
* Spotify
* Discord
* Reddit
* GeForce NOW

<Note>
  Ensure you are not hosting on a datacenter IP for CAPTCHAs to work reliably. Heavy amounts of traffic on a single IP may cause some sites to stop working. Consider rotating IPs or routing through Wireguard.
</Note>

## How it works

Scramjet operates in two main contexts:

1. **Window context** - Uses the `ScramjetController` to manage frames and communicate with the service worker
2. **Service worker context** - Uses `ScramjetServiceWorker` to intercept and rewrite requests

The service worker intercepts fetch requests, rewrites URLs and content, and returns modified responses that bypass restrictions while maintaining site functionality.

## Get started

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/installation">
    Install Scramjet via npm, yarn, or pnpm
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get a working proxy setup in minutes
  </Card>
</CardGroup>

## Next steps

Ready to get started? Follow our [installation guide](/installation) to set up Scramjet, then check out the [quickstart tutorial](/quickstart) to create your first proxy.