Getting Started with Bifrost

Getting Started with Bifrost

This guide will help you get Bifrost up and running quickly.

Prerequisites

• Go 1.24+ (for building from source)
• Docker (optional, for containerized deployment)

Installation

From Binary

Download the latest release from the releases page.

# Linux (amd64)
curl -LO https://github.com/rennerdo30/bifrost-proxy/releases/latest/download/bifrost_linux_amd64.tar.gz
tar -xzf bifrost_linux_amd64.tar.gz

# macOS (arm64)
curl -LO https://github.com/rennerdo30/bifrost-proxy/releases/latest/download/bifrost_darwin_arm64.tar.gz
tar -xzf bifrost_darwin_arm64.tar.gz

From Source

git clone https://github.com/rennerdo30/bifrost-proxy.git
cd bifrost
make build

With Docker

docker pull ghcr.io/bifrost-proxy/bifrost/server:latest
docker pull ghcr.io/bifrost-proxy/bifrost/client:latest

Quick Start

Server Setup

1. Create a configuration file server-config.yaml:

server:
  http:
    listen: ":7080"
  socks5:
    listen: ":7180"

backends:
  - name: direct
    type: direct
    enabled: true

routes:
  - domains: ["*"]
    backend: direct

metrics:
  enabled: true
  listen: ":7090"

2. Start the server:

./bifrost-server -c server-config.yaml

3. Verify it’s running:

curl http://localhost:7090/metrics

Client Setup

Option 1: Generate Config from CLI

# Generate a config file with your server address
./bifrost-client config init -s your-server:7080

# Or with custom options
./bifrost-client config init \
  -s your-server:7080 \
  -p socks5 \
  --http-listen 127.0.0.1:8888 \
  -o my-config.yaml

Option 2: Generate Config from Web Dashboard

1. Open your server’s web dashboard (e.g., http://your-server:7081)
2. Click “Config Generator” tab
3. Fill in the form and download the configuration

Option 3: Create Config Manually

Create a configuration file client-config.yaml:

proxy:
  http:
    listen: "127.0.0.1:7380"

server:
  address: "your-server:7080"

routes:
  - domains: ["*"]
    action: server

Start the Client

./bifrost-client -c client-config.yaml

Configure Your Applications

See the Setup Guide tab in the web dashboard for detailed instructions, or use these common methods:

Browser:

• Configure your browser to use 127.0.0.1:7380 as HTTP proxy

Environment Variables:

export HTTP_PROXY=http://127.0.0.1:7380
export HTTPS_PROXY=http://127.0.0.1:7380

Command Line:

curl -x http://127.0.0.1:7380 https://example.com

Testing the Setup

Test with curl:

# HTTP proxy
curl -x http://127.0.0.1:7380 http://httpbin.org/ip

# SOCKS5 proxy
curl --socks5 127.0.0.1:7381 http://httpbin.org/ip

Next Steps

• Configuration Guide - Full configuration reference
• Backend Guide - Configure WireGuard, OpenVPN, and proxy backends
• Authentication Guide - Set up authentication
• API Reference - REST API documentation