Skip to content

Operator Guides

How-to documentation for skywire operators. Conceptual overview and the latest install methods stay in the repo-root README; this directory holds the in-depth setup/usage guides.

For per-command help text (flags, usage, examples), see the generated command reference — docs/skywire/ mirrors the cobra subcommand tree.

Setup

  • install.md — install via go install / go run, Linux packages, Docker, NixOS, release binaries
  • permissions.md — VPN client CAP_NET_ADMIN, VPN server iptables/sysctl, file system + survey
  • configuration.md — config gen flags, hypervisor web UI, hypervisor TUI, remote hypervisors, network visualization UI
  • visor.md — running skywire visor, process control / while-loop pattern, transport setup, runtime files

Application usage

  • vpn.md — Skywire VPN client/server with skywire cli vpn
  • socks5.md — Skywire SOCKS5 proxy client with skywire cli proxy
  • skynet.md — SkyNet P2P port forwarding with skywire cli skynet
  • standalone-skychat.md — skywire app skychat --standalone --tcp-listen :PORT for visor-independent chat-app with direct-TCP entry point; port-forwarding caveats
  • standalone-dmsgpty-host.md — skywire dmsg pty host --tcplisten :PORT for visor-independent pty server with DMSG + TCP modes; port-forwarding caveats

Advanced

  • manual-routing.md — manual route creation, multi-hop routes, route-finder, troubleshooting

Maintainer

  • testing.md — pre-PR make format check workflow
  • release.md — creating a GitHub release with goreleaser