Anisail documentation
This directory contains detailed documentation for Anisail: the Ansible connection plugin and tunnel binary that use Holesail P2P tunnels to reach hosts behind NAT.
Getting started
| Doc | Description |
|---|---|
| INSTALLATION.md | Install the tunnel binary (scripts or build) and the Ansible collection |
| USAGE.md | Inventory, playbooks, and target setup |
Reference
| Doc | Description |
|---|---|
| ARCHITECTURE.md | System design, data flow, and repo layout |
| CONNECTION-PLUGIN.md | Ansible connection plugin options and internals |
| TUNNEL.md | anisail-tunnel CLI, protocol, and Bare compatibility |
| BUILD.md | Building the tunnel binary and release zips |
| CI-AND-RELEASES.md | CI workflow and rolling release process |
| INSTALLERS.md | Install script behavior and environment variables |
Operations
| Doc | Description |
|---|---|
| TROUBLESHOOTING.md | Common errors and how to fix them |
Contributing and security
| Doc | Description |
|---|---|
| CONTRIBUTING.md | How to contribute code and docs |
| SECURITY.md | Security model and recommendations |