Fyr
Fyr is an offline-first content platform for maps, books, and knowledge archives.
It runs as a local web server and works without internet once content is present.
Project status: Fyr is currently in preview. Interfaces and workflows may continue to evolve.
Features
- Single-service deployment — no external database, cache server, or sidecar services required
- Offline maps with PMTiles and MBTiles
- Library with EPUB, PDF, Markdown, and ZIM reading
- Native Fyr ZIM reader service with server-side archive access
- Local AI assistant for GGUF models
- Download queue and local content management for maps, books, models, POI, and misc files
- Tools: unit converters and encryption/ciphering utilities (AES, Base64, ROT13, hashing) — fully offline on your local Fyr deployment
Quick Install
The fastest way to try Fyr is with the official hosted installer:
Linux / macOS
curl -fsSL https://fyr.guide/install.sh | sh
Windows PowerShell
irm https://fyr.guide/install.ps1 | iex
The installer handles Docker setup, data persistence, and remembers your settings for future upgrades. To update later, add the update argument:
curl -fsSL https://fyr.guide/install.sh | sh -s -- update
If you need the compatibility-first legacy image on older hardware, use the installer shortcut:
curl -fsSL https://fyr.guide/install.sh | sh -s -- --legacy
irm https://fyr.guide/install.ps1 | iex; Install-Fyr -Legacy
See fyr.guide/#installation for the full installation guide, including manual Docker commands, building from source, and Raspberry Pi deployment.
One-Minute Start (From Source)
If you have Rust installed and prefer to build locally:
cargo build --release -p server --bin fyr
./target/release/fyr
For a CPU-tuned local build on the same machine that will run Fyr, enable Rust's auto-detected native target features:
RUSTFLAGS="-C target-cpu=native" cargo build --release -p server --bin fyr
./target/release/fyr
PowerShell:
$env:RUSTFLAGS="-C target-cpu=native"
cargo build --release -p server --bin fyr
.\target\release\fyr.exe
Remove-Item Env:RUSTFLAGS
Open http://localhost:8080 on the same machine.
Installation & Deployment
The canonical installation guide lives at fyr.guide/#installation and includes:
- Building from source for development workflows.
- Running with Docker (both Production and Dev releases) on an existing system.
- Installing and running Fyr on a clean Raspberry Pi OS setup.
Docker release tags are intentionally simple:
hexagon/fyr:latest and hexagon/fyr:vX.Y.Z are optimized defaults.hexagon/fyr:legacy and hexagon/fyr:vX.Y.Z-legacy are compatibility-first fallbacks.hexagon/fyr:pc-legacy and hexagon/fyr:rpi-legacy are explicit legacy targets for older PCs and older Raspberry Pi-class arm64 hardware.
Documentation Map
Data Management
Fyr stores user content in a persistent data directory (./public/data by default, /data in Docker).
See fyr.guide/#installation for persistence setup and the User Manual data layout section for folder-level details.
License
This repository is licensed under MIT. See LICENSE.
