Repository navigation
Fyr 0.3.0 - Initial (pre)release
Pre-release
Pre-release
This is the initial prerelease of Fyr, a rugged, offline-first companion platform for maps, books, and knowledge archives. Fyr runs as a local web server and is designed to operate entirely without an internet connection once your content is loaded. It is fully self-contained with zero dependencies on external servers or cloud services—everything runs locally, relying solely on your designated data folder for content.
Core Features
- Fully Self-Contained Architecture: No external API or server dependencies. The entire platform runs locally from your machine, requiring only your data folder (
DATA_DIR) to serve and manage content. - Knowledge Archives & Library: Full offline reading support for EPUB, PDF, and Markdown files. Includes a native, server-side ZIM reader for seamlessly browsing massive offline archives (like Wikipedia) without the need for external parsing libraries.
- Offline Maps: Fully functional local mapping capabilities using PMTiles.
- Local AI Assistant: Chat with an integrated AI assistant powered by local GGUF models, ensuring complete privacy and off-grid availability.
- Local Content Management: Built-in download queue and management system for handling maps, books, AI models, Points of Interest (POIs), and miscellaneous files.
- Auto-Updating Documentation: Comes with built-in user and developer manuals that automatically refresh within your library on startup.
Quick Start
Run with Docker:
docker run --rm -p 8080:8080 \
-e FYR_HOST=0.0.0.0 \
-e DATA_DIR=/data \
-v fyr-data:/data \
hexagon/fyr:latestBuild and Run from Source:
cargo build --release -p server --bin fyr
./target/release/fyr
Once running, simply open [http://127.0.0.1:8080](http://127.0.0.1:8080) in your browser.
What's Changed
- Fix Docker image shipping stub fyr binary by @Hexagon with @Copilot in #1
- Update main branch by @Hexagon in #2
- Fix dev release Docker build for vendored zim crate by @Hexagon with @Copilot in #3
- Use origin-relative frontend URLs for Docker-published Fyr hosts by @Hexagon with @Copilot in #4
- Update main by @Hexagon in #6
New Contributors
Full Changelog: https://github.com/Hexagon/fyr/commits/v0.3.0