Default
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 — ideal for homes, field use, air-gapped networks, or low-bandwidth environments.
Features
- Offline maps — render vector maps locally using PMTiles, with no external tile server required.
- Library — read EPUB, PDF, Markdown, and ZIM files entirely on-device.
- Native ZIM reader — server-side archive access for Wikipedia and other Kiwix-format content.
- Local AI assistant — load and chat with GGUF language models without sending data to the cloud.
- Download queue — fetch maps, books, AI models, POI data, and miscellaneous files from curated or custom sources.
- Content management — import local files, inspect the content inventory, and organise all assets in one place.
Quick Start
The fastest way to run Fyr is with Docker:
class="highlight">
1
2
3
4
5
docker run --rm -p 8080:8080 \
-e FYR_HOST=0.0.0.0 \
-e DATA_DIR=/data \
-v fyr-data:/data \
hexagon/fyr:latest
Open http://localhost:8080 in a browser on the same machine, or http://<host-ip>:8080 from any device on your network.
Build from Source
If you have Rust installed and prefer to build locally:
class="highlight">1
2
cargo build --release -p server --bin fyr
./target/release/fyr
Then open http://localhost:8080.
Further Reading
- Installation guide — Docker, Raspberry Pi, and source build instructions.
- User manual — detailed usage reference for all features.
- Developer manual — architecture, API, and contribution guide.
- Source code — MIT licensed, contributions welcome.