Skip to main content

Installation

Quick Start​

Choose your preferred installation method:

Docker

Easiest setup, works everywhere

Native Binary

Flexible deployment

The fastest way to get started. No dependencies, no configuration needed.

Basic Setup​

docker run -it --rm \
  -e API_KEY="<YOUR_OPENROUTER_KEY>" \
  -p 80:80 \
  -v "$(pwd)/data:/data" \
  ghcr.io/pinkfuwa/llumen:latest
note

Replace <YOUR_OPENROUTER_KEY> with your actual API key from OpenRouter

What This Does​

  • Downloads the latest llumen image (~17MB)
  • Starts the server on port 80
  • Creates a data folder for persistent storage
  • Sets your API key for LLM access

Access Your Instance​

Open your browser and navigate to:

Default credentials:

  • Username: admin
  • Password: P@88w0rd
warning

Change the default password immediately after first login!

Persistent Storage​

To keep your conversations and settings:

docker run -d \
  --name llumen \
  -e API_KEY="your-key-here" \
  -p 80:80 \
  -v ./llumen-data:/data \
  --restart unless-stopped \
  ghcr.io/pinkfuwa/llumen:latest

Using Nightly Builds​

For the latest features (may be unstable):

docker run -p 80:80 \
  -e API_KEY="your-key-here" \
  -v ./data:/data \
  ghcr.io/pinkfuwa/llumen:nightly

Native Binary​

For maximum performance and minimal resource usage.

Download​

Get the latest release for your platform:

Linux (x86_64):

wget https://github.com/pinkfuwa/llumen/releases/download/latest/llumen-x86_64-unknown-linux-gnu
chmod +x llumen-x86_64-unknown-linux-gnu

Linux (ARM64/aarch64):

wget https://github.com/pinkfuwa/llumen/releases/download/latest/llumen-aarch64-unknown-linux-gnu
chmod +x llumen-aarch64-unknown-linux-gnu

Windows:

# Download from GitHub Releases page
https://github.com/pinkfuwa/llumen/releases/download/latest/llumen-x86_64-pc-windows-msvc.exe

Run​

# Set API key
export API_KEY="your-openrouter-key"

# Run llumen
./llumen-x86_64-unknown-linux-gnu

Platform-Specific Notes​

Raspberry Pi

Installation:

# Use ARM64 binary
wget https://github.com/pinkfuwa/llumen/releases/download/latest/llumen-aarch64-unknown-linux-gnu
chmod +x llumen-aarch64-unknown-linux-gnu
./llumen-aarch64-unknown-linux-gnu
Windows

Download: Get the .exe from releases

Run:

# PowerShell
$env:API_KEY="your-key"
.\llumen.exe

Firewall: You may need to allow llumen through Windows Firewall

Troubleshooting​

Port 80 already in use

Use a different port:

docker run -p 8080:80 ... ghcr.io/pinkfuwa/llumen:latest

Access at http://localhost:8080

Unable to connect 80

Docker build has default port 80.

Other deployment option has default port 3000, and bind only to local interface (You cannot access llumen from other device).

Can't connect from network
  • Check firewall settings
  • Ensure using 0.0.0.0:80 not 127.0.0.1:80
  • Verify correct IP address