From 123086fe74bd708f75af7d5b46e7e75b0c4f7575 Mon Sep 17 00:00:00 2001 From: jiangyuer018 <2877716584@qq.com> Date: Fri, 16 Oct 2026 21:14:35 +0800 Subject: [PATCH] docs: document v0.1.0 installation --- README.md | 30 ++++++++++++++++++++---------- SECURITY.md | 2 +- docs/setup.md | 6 +++--- 3 files changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index aa72e27..1411704 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ nodkey lets an AI coding agent use a secret or an SSH key only after a person approves that one request on a phone. -**Status:** on 2026-10-15, the code of version 1 is on `main`, and the -test with a real Telegram bot -([#17](https://github.com/code6x/nodkey/issues/17)) is done. There is no -release yet. Try it on a test setup first. See the +**Status:** on 2026-10-15, the code of version 1 is on `main`, the test with +a real Telegram bot ([#17](https://github.com/code6x/nodkey/issues/17)) is +done, and the first release, [v0.1.0](https://github.com/code6x/nodkey/releases/tag/v0.1.0), +is available. Try it on a test setup first. See the [v1 milestone](https://github.com/code6x/nodkey/milestone/1). ## How it works @@ -48,17 +48,27 @@ clipboard, terminals and browser. Keep no SSH key or other way to get root on the broker host on the agent machine ([docs/setup.md section 1](docs/setup.md#where-you-do-the-setup)). -1. **Install** `nodkey` on both machines. There is no release yet, so - build it from this repository with Go 1.26 or newer, on a trusted - machine, never on the agent machine: +1. **Install** `nodkey` on both machines. From a release, download the + tarball for your machine and `SHA256SUMS` from the + [release page](https://github.com/code6x/nodkey/releases). Check both as + described in [Verify a download](docs/releasing.md#verify-a-download), + then extract and install it: + + ```sh + tar -xzf nodkey_0.1.0_linux_amd64.tar.gz nodkey + install -o root -g root -m 0755 nodkey /usr/local/bin/nodkey + ``` + + Copy the file straight to both machines, not through the agent machine. + **From the source**, build it with Go 1.26 or newer on a trusted machine, + never on the agent machine: ```sh CGO_ENABLED=0 go build -trimpath -o nodkey ./cmd/nodkey ``` - Copy the file straight to both machines, not through the agent - machine. On the broker host, `sha256sum nodkey` must print the same - SHA-256 as on the build machine. Install it as root: + On the broker host, `sha256sum nodkey` must print the same SHA-256 as on + the build machine. Install it as root: ```sh install -o root -g root -m 0755 nodkey /usr/local/bin/nodkey diff --git a/SECURITY.md b/SECURITY.md index 10f0a36..0de4c3b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -33,4 +33,4 @@ normal issues. ## Supported versions -There is no release yet. Until 1.0, only the latest release gets fixes. +Until 1.0, only the latest release (`v0.1.0`) gets fixes. diff --git a/docs/setup.md b/docs/setup.md index 5ed8828..0d505ad 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -112,9 +112,9 @@ tar -xzf nodkey_0.1.0_linux_amd64.tar.gz nodkey install -o root -g root -m 0755 nodkey /usr/local/bin/nodkey ``` -**From the source.** There is no release yet on 2026-10-15. Build nodkey -with Go 1.26 or newer, on a trusted machine. Never build it on an agent -machine: the agent could change the build. +**From the source.** Build nodkey with Go 1.26 or newer, on a trusted +machine. Never build it on an agent machine: the agent could change the +build. ```sh git clone https://github.com/code6x/nodkey.git