Fluxheim/Docs/Get Fluxheim Running

Get Fluxheim Running

Use this page when you want a local server quickly. It keeps the config small and checks it before serving traffic.

Install a release binary

curl -L https://github.com/valkyoth/fluxheim/releases/download/v1.6.30/fluxheim-1.6.30-full-x86_64-linux.tar.gz -o fluxheim.tar.gz
tar -xzf fluxheim.tar.gz
sudo install -m 0755 fluxheim /usr/local/bin/fluxheim

Minimal static site

[server]
listen = ["0.0.0.0:8080"]
default_vhost = "site"

[[vhosts]]
name = "site"
hosts = ["example.com"]

[vhosts.web]
root = "/srv/example"
index_files = ["index.html"]
deny_dotfiles = true

What the first config does

OptionPurpose
server.listenControls the plain HTTP socket Fluxheim opens.
server.default_vhostSelects the fallback site when no host matches.
vhosts.hostsLists the hostnames accepted by the site.
vhosts.web.rootPoints at the directory served to visitors.

Check and start

fluxheim --config /etc/fluxheim/fluxheim.toml --check-config
fluxheim --config /etc/fluxheim/fluxheim.toml

Use the config check in deployment scripts. It catches unknown fields, unsafe paths, invalid listeners, and feature/config mismatches before traffic moves.

Next useful choices

  • Add TLS only after DNS points at the host.
  • Add cache only for routes that are safe to share between visitors.
  • Add metrics only when the listener is private or behind a trusted proxy.
English (US)