-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Helix is a local-first Linux dashboard for the host, its files, and game servers. It pairs a fast web interface with an unprivileged daemon and a narrow typed Linux broker, so useful host controls do not require a general root shell.
Helix 1.0 is a private-LAN release. Keep it on a network you control, do not expose it directly to the public internet, and do not trust it as the only copy of important data.
The source is licensed under AGPL-3.0-or-later. Open source availability does
not imply production support or a completed security review.
Helix brings the common jobs for one server into one place:
- multiple exportable Home layouts with drag-and-drop/resizable status, clock, weather, graphs, Docker, paged-note, shortcut, Strand, and Globe widgets plus color controls; pin the site to open Home, or use full-screen Home;
- live host, storage, network, service, process, Docker, and Helix resource views;
- a Security center for explained, confirmed host and Helix protections;
- mounted-drive browsing, bounded text editing, recoverable deletion, and cancellable largest-file/folder analysis;
- a native Docker-backed manager for Minecraft (Paper, Purpur, Folia, Leaves, Fabric, Forge, NeoForge, Quilt, Pufferfish, Vanilla, custom JAR), V Rising, Valheim, and Terraria;
- persistent bounded console history, settings with restart guidance, backups, a compatibility-aware Modrinth marketplace, and server-safe Modrinth or CurseForge modpack create;
- optional AMP discovery and control without pretending AMP instances are Helix-native;
- Hooks for Plex, AMP, Tailscale, Pterodactyl Wings, Jellyfin, Docker, and Portainer, including eligible one-click Tailscale/Jellyfin installs;
- an optional current-password-gated non-root Linux PTY;
- Strands: drop in someone else's
.strand.zip(or pack your own) for isolated pages/widgets that can call metrics, namespaced storage, or an allowlisted HTTPS API; and - selected APT updates, immediate/recurring host reboot, UFW safety activation, and exact Helix start-on-boot controls with explicit preflight/confirmation.
The dashboard is the control plane, not the game process or player network path. Closing Helix does not stop a native game container. Actual player capacity still depends on the host, world, server software, configuration, and mods or plugins.
On 64-bit systemd Linux, clone the source and run
./scripts/install-from-source.sh. On a terminal that one command walks
through yes/no setup and puts helixd on loopback (another port if 8080 is
taken). Create the owner with your own display name. Host files, firewall,
packages, and native game servers still need the broker from the container
deployment guide. Nothing ships with a demo city or demo server.
- Getting Started
- How Helix Works
- Dashboard and Home
- Storage and Files
- Servers and Marketplace
- Network, Host, and Updates
- Hooks and Terminal
- Architecture
- Security and Recovery
- Game Hosting and Capacity
- Building Strands
- Roadmap and Status
Broad/unattended package upgrades, public-network exposure, portable Wasm Strands, and native Strand sidecars are not implemented. Helix can apply a SHA-256-pinned GitHub release to itself from Host → Linux updates. Exact selected APT candidates do have a guarded path but no rollback claim. Helix can inspect UFW, manage exact owned allow rules, and separately enable inactive UFW only after preserving a verified SSH listener; it cannot configure a router or prove outside reachability. It can work behind an already configured private Tailscale route and install/start the exact service on eligible Debian/Ubuntu hosts, but it does not authenticate the tailnet or widen network trust.
Modpack creation searches Modrinth, and CurseForge when an owner API key is saved in Settings → Catalogs. It pins a supported loader (Fabric, Forge, NeoForge, or Quilt), and starts an isolated server. The result is a server-safe subset, not a full client copy. Broad pack matrices and every upstream failure mode stay open.
The authoritative implementation ledger is
PROGRESS.md.