Skip to content

Installation

Quick Start

The recommended way to install Bifract is with the Linux setup wizard. It handles SSL, secure passwords, Docker Compose, and database initialization:

curl -sfL https://docs.bifract.io/install.sh | sh

To upgrade an existing installation (if bifract is already installed):

sudo bifract --upgrade

This automatically checks for a newer version of bifract itself, downloads it if available, then runs the upgrade.

Architecture

graph TB
    users["Users / Browsers"]
    sources["Log Sources"]

    subgraph docker ["Docker Network"]
        caddy["Caddy<br/><small>Reverse Proxy + TLS</small>"]
        bifract["Bifract<br/><small>Go Backend + Web UI</small>"]
        pg[("PostgreSQL<br/><small>Users, Config, Alerts</small>")]
        ch[("ClickHouse<br/><small>Log Storage</small>")]
        litellm["LiteLLM<br/><small>AI Proxy</small>"]
    end

    users -- "HTTPS :443" --> caddy
    sources -- "HTTPS :8443" --> caddy
    caddy -- ":8080" --> bifract
    caddy -. "Access Logs" .-> bifract
    bifract -- ":5432" --> pg
    bifract -- ":9000" --> ch
    bifract -- ":8000" --> litellm
    litellm -. "OpenAI / Anthropic API" .-> ext["LLM Providers"]

System Requirements

Bifract is supported on Linux x86_64 (amd64). The installer and pre-built binaries target this architecture.

Hardware Sizing

Recommended hardware for single-node Docker Compose deployments based on daily raw log volume.

Daily Ingest CPU Cores RAM
10 GB 4 8 GB
50 GB 8 16 GB
100 GB 16 32 GB
250 GB 16 64 GB
500 GB 32 128 GB

For disk, ClickHouse typically achieves 7-10x compression on structured log data, so 10 GB/day of raw logs compresses to roughly 1-1.5 GB/day on disk.