@ollamawg/cli 0.4.0 → 0.4.1

package/README.md

@@ -6,7 +6,13 @@ Reach your Ollama server from your laptop and phone without exposing it to the i
 
 It is a single Go binary. WireGuard runs in user space through [wireguard-go](https://git.zx2c4.com/wireguard-go) and gVisor's network stack, so the server needs no root, no kernel module and no TUN device. Computers connect with `ollamawg connect`, which needs no admin rights either. Phones use the official WireGuard app, because the keys and protocol are standard WireGuard.
 
-![Dashboard](https://raw.githubusercontent.com/himanshu-mamgain/ollamawg/v0.4.0/docs/images/dashboard.png)
+**Website:** https://himanshu-mamgain.github.io/ollamawg/
+
+> **Important**
+>
+> **ollamawg has not had an independent security audit.** Treat it as an evolving security tool, not an independently verified security product. The cryptography comes from wireguard-go and gVisor, which are widely deployed. ollamawg's own policy, proxy and dashboard code is small and covered by end-to-end tests, but nobody outside the project has reviewed it. Read the [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/security.md) before you rely on it, and report problems as described there.
+
+![Dashboard](https://raw.githubusercontent.com/himanshu-mamgain/ollamawg/v0.4.1/docs/images/dashboard.png)
 
 <sub>Screenshot taken with simulated devices and traffic.</sub>
 
@@ -43,17 +49,33 @@ Ollama itself stays on `127.0.0.1`. Nothing outside the tunnel can talk to it.
   - ask your ISP for a public IP;
   - or relay through a small VPS.
 
-  See [Troubleshooting](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/getting-started.md#troubleshooting).
+  See [Troubleshooting](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/getting-started.md#troubleshooting).
 
 ## Install
 
+No npm or Go needed: these scripts download the binary for your platform from [GitHub Releases](https://github.com/himanshu-mamgain/ollamawg/releases), check it against the release's `SHA256SUMS`, and install it without admin rights.
+
+```powershell
+# Windows (PowerShell): installs to %LOCALAPPDATA%\Programs\ollamawg and adds it to PATH
+irm https://himanshu-mamgain.github.io/ollamawg/install.ps1 | iex
+```
+
+```sh
+# macOS, Linux, FreeBSD: installs to /usr/local/bin if writable, else ~/.local/bin (never uses sudo)
+curl -fsSL https://himanshu-mamgain.github.io/ollamawg/install.sh | sh
+```
+
+You can read the scripts first: [install.ps1](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/site/install.ps1), [install.sh](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/site/install.sh). Set `OLLAMAWG_VERSION=0.4.0` to pin a version, or `OLLAMAWG_INSTALL_DIR` to choose where it goes.
+
+Or use a package manager:
+
 ```sh
 npm install -g @ollamawg/cli        # prebuilt binary for Linux, macOS, Windows and FreeBSD
 npx @ollamawg/cli version           # or run it without installing
 go install github.com/himanshu-mamgain/ollamawg/cmd/ollamawg@latest
 ```
 
-Standalone binaries are attached to every [GitHub Release](https://github.com/himanshu-mamgain/ollamawg/releases). A `Dockerfile` is included; see [Running as a service](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/deploy.md#docker).
+You can also download a binary from any [GitHub Release](https://github.com/himanshu-mamgain/ollamawg/releases) yourself. A `Dockerfile` is included; see [Running as a service](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/deploy.md#docker).
 
 ## Quickstart
 
@@ -66,6 +88,8 @@ ollamawg serve
 
 `init` writes `server.yaml` and prints the dashboard password. Open `http://127.0.0.1:8088` on the server, or reach it over SSH with `ssh -L 8088:127.0.0.1:8088 server`.
 
+On Windows, `init` also lets devices through Windows Firewall: click **Yes** when Windows asks for permission. If you skip it or pass `--no-firewall`, run `ollamawg firewall` later.
+
 ### Add a laptop
 
 ```sh
@@ -97,11 +121,11 @@ Ollama apps such as Enchanted or Reins work too: point them at `http://10.77.0.1
 
 **Missed the QR code, lost a config, or got a new phone?** The server never stores device private keys, so a config can't be shown twice. Issue a new one instead: `ollamawg reissue --name phone --qr`, or **New config** on the device in the dashboard. The device keeps its name, address and policy, and the old config stops working.
 
-<img src="https://raw.githubusercontent.com/himanshu-mamgain/ollamawg/v0.4.0/docs/images/chat.png" alt="The chat page on a phone" width="300">
+<img src="https://raw.githubusercontent.com/himanshu-mamgain/ollamawg/v0.4.1/docs/images/chat.png" alt="The chat page on a phone" width="300">
 
 <sub>Chat page on a phone, with a simulated model reply.</sub>
 
-See [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/getting-started.md) for the full walkthrough.
+See [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/getting-started.md) for the full walkthrough.
 
 ## Dashboard login
 
@@ -131,7 +155,7 @@ With 2FA on:
 - The dashboard opens on a login form that asks for the username, password and code.
 - Scripts and Prometheus use the API token (`admin.api_token`) as `Authorization: Bearer <token>`.
 
-See [Dashboard and admin API](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/dashboard.md).
+See [Dashboard and admin API](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/dashboard.md).
 
 ## Features
 
@@ -174,6 +198,7 @@ Server
   serve        run the tunnel, proxy, chat page and dashboard
   passwd       set your own dashboard username and password
   2fa          enable, disable or check two-factor dashboard login
+  firewall     let devices through the Windows Firewall (one permission prompt)
 
 Client
   connect      bring the tunnel up and expose Ollama on 127.0.0.1:11434
@@ -190,19 +215,19 @@ Run `ollamawg <command> -h` for a command's flags.
 
 | Guide | What's in it |
 |---|---|
-| [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/getting-started.md) | Install, set up a server, add laptops and phones, connect |
-| [Configuration](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/configuration.md) | Every field in `server.yaml` and client configs, roles, model rules |
-| [Dashboard and admin API](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/dashboard.md) | The UI, two-factor login, the HTTP API behind it, Prometheus metrics |
-| [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/security.md) | What is protected, how, and what is not |
-| [Running as a service](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/deploy.md) | systemd, launchd, Windows, Docker, port forwarding |
-| [Go library](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/library.md) | Embedding the server and client in your own programs |
+| [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/getting-started.md) | Install, set up a server, add laptops and phones, connect |
+| [Configuration](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/configuration.md) | Every field in `server.yaml` and client configs, roles, model rules |
+| [Dashboard and admin API](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/dashboard.md) | The UI, two-factor login, the HTTP API behind it, Prometheus metrics |
+| [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/security.md) | What is protected, how, and what is not |
+| [Running as a service](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/deploy.md) | systemd, launchd, Windows, Docker, port forwarding |
+| [Go library](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/library.md) | Embedding the server and client in your own programs |
 
 ## Limitations
 
 - **Devices need to reach one UDP port on the server.** There is no relay or NAT traversal. CGNAT connections need one of the workarounds in [Requirements](#requirements).
 - **The dashboard has one admin account.** Put a reverse proxy with SSO in front if several people manage it.
 - **Chat history lives in each device's browser.** It is not synced between devices or stored on the server.
-- **No independent security audit yet.** The cryptography comes from wireguard-go and gVisor. The policy layer is small and covered by end-to-end tests. See the [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/docs/security.md).
+- **No independent security audit yet.** Treat ollamawg as an evolving security tool, not an independently verified security product. The cryptography comes from wireguard-go and gVisor; the policy layer is small and covered by end-to-end tests. See the [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/docs/security.md).
 
 ## Building from source
 
@@ -216,7 +241,7 @@ Go 1.24 or newer is required. Cross-compiling works out of the box, for example
 
 ## Releasing
 
-Releases are cut from `main` by [`.github/workflows/publish.yml`](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/.github/workflows/publish.yml):
+Releases are cut from `main` by [`.github/workflows/publish.yml`](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/.github/workflows/publish.yml):
 
 1. In a PR, bump `version` (and its `optionalDependencies`) in `npm/cli/package.json` and `Version` in `server.go`. A test fails if they differ.
 2. Merge the PR. The workflow publishes every npm package that's missing that version, using trusted publishing with provenance, then creates the GitHub Release with binaries.
@@ -225,4 +250,4 @@ A re-run finishes a release that stopped halfway.
 
 ## License
 
-[MIT](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.0/LICENSE)
+[MIT](https://github.com/himanshu-mamgain/ollamawg/blob/v0.4.1/LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ollamawg/cli",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Reach your Ollama server from anywhere through a user-space WireGuard tunnel, with per-device access control and a dashboard.",
   "keywords": [
     "ollama",
@@ -28,11 +28,11 @@
     "node": ">=16"
   },
   "optionalDependencies": {
-    "@ollamawg/darwin-arm64": "0.4.0",
-    "@ollamawg/darwin-x64": "0.4.0",
-    "@ollamawg/freebsd-x64": "0.4.0",
-    "@ollamawg/linux-arm64": "0.4.0",
-    "@ollamawg/linux-x64": "0.4.0",
-    "@ollamawg/win32-x64": "0.4.0"
+    "@ollamawg/darwin-arm64": "0.4.1",
+    "@ollamawg/darwin-x64": "0.4.1",
+    "@ollamawg/freebsd-x64": "0.4.1",
+    "@ollamawg/linux-arm64": "0.4.1",
+    "@ollamawg/linux-x64": "0.4.1",
+    "@ollamawg/win32-x64": "0.4.1"
   }
 }