# Zeiroh v0.1.0 - Table of Contents

> Phoenix FLAME overlay for Iroh and Zenoh. Launch Zeiroh, or cluster via IngotCluster / Dusk. Crucible boots machines.

## Pages

- [Zeiroh](readme.md)
- [Evaluation — Zeiroh, IngotCluster, Dusk, FLAME](eval.md)
- [Scaling plan — provision compute, overlay Iroh/Zenoh](scaling.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)
- [Funding](funding.md)
- [Contributing](contributing.md)
- [Security](security.md)

## Modules

- [Zeiroh](Zeiroh.md): Phoenix **FLAME** backends for **Iroh** and **Zenoh**.
- [Zeiroh.CLI](Zeiroh.CLI.md): Standalone CLI (`zeiroh`) and Mix task (`mix zeiroh`).
- [Zeiroh.Cluster](Zeiroh.Cluster.md): Starts Iroh and/or Zenoh overlay for FLAME runners.
- [Zeiroh.FLAME.Backend](Zeiroh.FLAME.Backend.md): Phoenix **FLAME** backend with Iroh and/or Zenoh membership overlay.
- [Zeiroh.FLAME.Iroh](Zeiroh.FLAME.Iroh.md): Phoenix **FLAME** backend using the **Iroh** (iron) overlay only.
- [Zeiroh.FLAME.Zenoh](Zeiroh.FLAME.Zenoh.md): Phoenix **FLAME** backend using the **Zenoh** overlay only.
- [Zeiroh.Iroh](Zeiroh.Iroh.md): Iroh overlay process. Uses `IngotCluster.Iroh` when loaded; otherwise a stub.

- [Zeiroh.Zenoh](Zeiroh.Zenoh.md): Zenoh overlay process. Uses `IngotCluster.Zenoh` or `Dusk.Zenoh` when loaded.

## Mix Tasks

- [mix zeiroh](Mix.Tasks.Zeiroh.md): Zeiroh CLI. Same as the `zeiroh` escript.
- [mix zeiroh.binary](Mix.Tasks.Zeiroh.Binary.md): Build a Burrito single-file CLI (ERTS inside). Needs zig + xz.
- [mix zeiroh.install](Mix.Tasks.Zeiroh.Install.md): Install zeiroh: Burrito single binary if possible, else escript.

