Merge pull request #9 from netfoundry/feature/update_readme

update build/readme

Author: emoscardini

README.md

@@ -26,30 +26,21 @@ The Ziti network enforces who can reach which machines; `sshd` on each machine o
 
 - An operational OpenZiti network (controller + at least one edge router). See the [OpenZiti quickstart](https://openziti.io/docs/learn/quickstarts/) if you do not have one yet.
 - **On user machines:** `ziti-ssh` installed (from this repo) and a Ziti identity enrolled.
-- **On the CA host:** Go 1.22 or later (to build from source), or the pre-built `ziti-ssh-ca` binary.
-- **On each SSH target host:** Go 1.22 or later (to build from source), or the pre-built `ziti-ssh-host` binary. Ubuntu 22.04 or later (or any distro with OpenSSH 8.2+ and systemd).
+- **On each SSH target host:** Ubuntu 22.04 or later (or any distro with OpenSSH 8.2+ and systemd).
 
 ---
 
 ## Building
 
-```sh
-git clone https://github.com/netfoundry/ziti-ssh.git
-cd ziti-ssh
-go build -o ziti-ssh-ca   ./cmd/ziti-ssh-ca
-go build -o ziti-ssh-host ./cmd/ziti-ssh-host
-go build -o ziti-ssh      ./cmd/ziti-ssh
-go build -o ziti-scp      ./cmd/ziti-scp
-```
-
-All binaries are statically linked (no CGO). Copy each binary to the machine where it will run. `ziti-ssh` and `ziti-scp` belong on user machines; `ziti-ssh-ca` and `ziti-ssh-host` are server-side components.
+See [docs/building.md](docs/building.md) for all installation and build options.
 
 ---
 
 ## Documentation
 
 | File | Purpose |
 |---|---|
+| [docs/building.md](docs/building.md) | Getting binaries: download, Docker build, local build |
 | [docs/provisioning.md](docs/provisioning.md) | Ziti network setup, per-component installation |
 | [docs/usage.md](docs/usage.md) | End-user guide: certs, connecting, file copy, MFA |
 | [docs/configuration.md](docs/configuration.md) | Full flag/env/config reference for all binaries |

docs/building.md

@@ -0,0 +1,87 @@
+# Getting binaries
+
+Four options are available, from simplest to most hands-on.
+
+---
+
+## Download pre-built binaries (recommended)
+
+Pre-built `.tar.gz` archives for linux/amd64 and linux/arm64 are published on the [GitHub releases page](https://github.com/netfoundry/ziti-ssh/releases). No Go toolchain or Docker installation required.
+
+Download the archive for the component you need and extract it to a directory on your `PATH`.
+
+---
+
+## Build .deb packages with Docker
+
+`scripts/docker-build-deb.sh` builds all four `.deb` packages inside a Docker container. Docker is the only prerequisite — no Go toolchain is needed on the host.
+
+```sh
+# Default version (0.1.0):
+./scripts/docker-build-deb.sh
+
+# Explicit version:
+VERSION=1.2.3 ./scripts/docker-build-deb.sh
+```
+
+Output lands in `dist/`:
+
+```
+dist/ziti-ssh-ca_<version>_amd64.deb
+dist/ziti-ssh-host_<version>_amd64.deb
+dist/ziti-ssh_<version>_amd64.deb
+dist/ziti-scp_<version>_amd64.deb
+```
+
+The script also copies the raw binaries to the repository root for local testing.
+
+---
+
+## Build .deb packages locally
+
+`scripts/build-deb.sh` builds all four `.deb` packages directly on the host.
+
+**Prerequisites:** Go 1.22 or later, `dpkg-deb` (included in the `dpkg` package on Debian/Ubuntu).
+
+```sh
+# Default version (0.1.0):
+./scripts/build-deb.sh
+
+# Explicit version:
+VERSION=1.2.3 ./scripts/build-deb.sh
+```
+
+Output lands in `dist/`:
+
+```
+dist/ziti-ssh-ca_<version>_amd64.deb
+dist/ziti-ssh-host_<version>_amd64.deb
+dist/ziti-ssh_<version>_amd64.deb
+dist/ziti-scp_<version>_amd64.deb
+```
+
+The script also copies the raw binaries to the repository root for local testing.
+
+Copy each `.deb` to its target machine:
+
+| Package | Destination |
+|---|---|
+| `ziti-ssh-ca_<version>_amd64.deb` | Ziti controller host |
+| `ziti-ssh-host_<version>_amd64.deb` | Each target SSH host |
+| `ziti-ssh_<version>_amd64.deb` | Each user's machine |
+| `ziti-scp_<version>_amd64.deb` | Each user's machine (optional) |
+
+---
+
+## Build individual binaries (development)
+
+For one-off builds or development work, build individual binaries directly with `go build`:
+
+```sh
+go build -o ziti-ssh-ca   ./cmd/ziti-ssh-ca
+go build -o ziti-ssh-host ./cmd/ziti-ssh-host
+go build -o ziti-ssh      ./cmd/ziti-ssh
+go build -o ziti-scp      ./cmd/ziti-scp
+```
+
+All binaries are statically linked (no CGO). Copy each binary to the machine where it will run.

docs/provisioning.md

@@ -6,42 +6,7 @@ For end-user usage see [usage.md](usage.md). For a full flag and config referenc
 
 ---
 
-## Building the packages
-
-The deb packages are not yet published to an apt repository. Build them locally from source.
-
-**Prerequisites:**
-
-- `go` 1.21 or later
-- `dpkg-deb` (included in the `dpkg` package on Debian/Ubuntu)
-
-**Build:**
-
-```sh
-# Default version (0.1.0):
-./scripts/build-deb.sh
-
-# Explicit version:
-VERSION=1.2.0 ./scripts/build-deb.sh
-```
-
-Output lands in `dist/`:
-
-```
-dist/ziti-ssh-ca_<version>_amd64.deb
-dist/ziti-ssh-host_<version>_amd64.deb
-dist/ziti-ssh_<version>_amd64.deb
-dist/ziti-scp_<version>_amd64.deb
-```
-
-Each component has its own installation section below. Copy the packages to their target machines as directed:
-
-| Package | Destination |
-|---|---|
-| `ziti-ssh-ca_<version>_amd64.deb` | Ziti controller host |
-| `ziti-ssh-host_<version>_amd64.deb` | Each target SSH host |
-| `ziti-ssh_<version>_amd64.deb` | Each user's machine |
-| `ziti-scp_<version>_amd64.deb` | Each user's machine (optional) |
+For installation options — including pre-built binary downloads, Docker-based .deb builds, and local builds — see [building.md](building.md).
 
 ---