Llumen

⚡ a lightweight, performant LLM chat application with effortless setup 🚀

llumen is a lightweight, self-hostable LLM chat application (frontend + backend) that aims to provide an out-of-the-box experience for self-hosting users.

❓ Why choose llumen?

• 🔌 OpenAI Compatible: Works with any OpenAI-compatible endpoint (OpenRouter, local models, etc.)
• 🚢 Zero-Config Setup: Pre-integrated with OpenRouter for instant deployment
• 🤝 Multi-Platform Distribution: Windows executables, Docker images, Linux binaries with Arm64 support
• 🚀 Blazing Fast: Sub-second cold start, 30× smaller asset footprint and <128MB RAM usage
• 📘 Rich Markdown: Full code syntax highlighting and LaTeX math support
• 🔍 Advanced Modes: Standard chat, web-search integration, and deep-research capabilities 🧠
• 💻 Rich Features: Message editing, file uploads (PDFs, images, code), image generation

video.mp4

👉 Quickstart

Important

The default account is admin, password is P@88w0rd

🐳 Docker (Recommended)

• The repository includes a multi-stage Dockerfile that builds the frontend and the backend and produces a small image that serves static files and runs the server.
• Example: run the container (binds port 80 by default).

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

09:25:46.117Z INFO | Using endpoint https://openrouter.ai/api/v1/chat/completions for completions
09:25:46.180Z INFO | Listening on http://127.0.0.1:8001
09:25:46.295Z INFO | 344 models available

More docker-compose deployment sample here 👈

📦 Without docker

Tip

Prebuild-binary is not up to dated, it only built on per-release basis

We also provided prebuild binary, download it and extract from release.

🔑 Environment variables

• API_KEY (required) — OpenRouter or equivalent provider API key.
• OPENAI_API_BASE — openai compatible api url. Default: https://openrouter.ai/api
• DATABASE_URL — database connection string. Default in Docker: sqlite://data/db.sqlite?mode=rwc.
• BLOB_URL — path for redb object storage. Default in Docker: /data/blobs.redb.
• BIND_ADDR — address the backend binds to (default in Docker: 0.0.0.0:80).

📖 Where to look for more documentation

• User Guide: ./docs/user/README.md - Getting started, installation, configuration, and features
• Development and build-from-source steps and other developer-focused:
  • Build-from-source steps: ./docs/chore/README.md
  • Documentation generated by AI(supervised by human): ./docs/dev/README.md