> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vulcx.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Self-hosted

> Run your own Vulcx routing engine on your infrastructure using the community binary.

# Self-hosted

The Vulcan binary lets you run the full routing engine on your own server. It exposes the same API as the hosted instance — same endpoints, same response shapes — with no shared infrastructure.

<Info>
  **Hosted API vs self-hosted.** Use the [hosted API](/get-started/authentication) for managed infrastructure with no ops overhead. Choose self-hosted if you need full control, want to avoid third-party rate limits, or are building systems that can't depend on an external service.
</Info>

## Hosted vs self-hosted

|                | Hosted API                | Self-Hosted                        |
| -------------- | ------------------------- | ---------------------------------- |
| Auth           | API key (per plan)        | Community license key              |
| Rate limits    | Gateway-enforced per plan | Built into the binary, per license |
| Infrastructure | Managed by Vulcx          | Your server                        |
| RPC provider   | Managed by Vulcx          | FluxRPC (your key)                 |
| Cost           | Subscription              | RPC fees only                      |
| SLA            | Covered                   | Your responsibility                |

## Requirements

| Requirement                   | Where to get it                                |
| ----------------------------- | ---------------------------------------------- |
| FluxRPC key                   | [fluxrpc.com](https://fluxrpc.com?ref=VULCX)   |
| Community license key         | [license.vulcx.xyz](https://license.vulcx.xyz) |
| Linux server (amd64 or arm64) | Any VPS or bare metal                          |

The binary validates both at startup and refuses to start if either is missing or invalid.

## Quickstart

<Steps>
  <Step title="Copy the env file">
    ```bash theme={"theme":"github-dark"}
    curl -O https://raw.githubusercontent.com/vulcx/vulcan/main/.env.example
    cp .env.example .env
    ```
  </Step>

  <Step title="Fill in your credentials">
    Open `.env` and set:

    ```env theme={"theme":"github-dark"}
    RPC_URL=https://eu.fogo.fluxrpc.com?key=YOUR_FLUX_RPC_KEY
    YELLOWSTONE_TOKEN=YOUR_FLUX_RPC_KEY
    COMMUNITY_LICENSE_KEY=vulcxcom_xxxxxxxxxxxxxxxxxxxx
    COMMUNITY_LICENSE_API=https://license.vulcx.xyz
    ```
  </Step>

  <Step title="Run">
    ```bash theme={"theme":"github-dark"}
    curl -O https://raw.githubusercontent.com/vulcx/vulcan/main/docker-compose.yml
    docker compose up -d
    curl http://localhost:8080/health
    # → {"status":"ok"}
    ```
  </Step>
</Steps>

<CardGroup cols={2}>
  <Card title="Full deployment guide" icon="book" href="/guides/self-hosting">
    Nginx, SSL, systemd, referral fees, and the complete configuration reference.
  </Card>

  <Card title="vulcan on GitHub" icon="github" href="https://github.com/vulcx/vulcan">
    Docker images, binary releases, and the `.env.example` reference.
  </Card>
</CardGroup>


## Related topics

- [Self-hosting Vulcx](/guides/self-hosting.md)
- [SDK configuration](/sdk/configuration.md)
- [Introduction to Vulcx — best-price swaps on Fogo](/get-started/introduction.md)
- [Widget attributes](/widget/attributes.md)