@ollamawg/cli 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -14
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Reach your Ollama server from your laptop and phone without exposing it to the i
|
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
|
-

|
|
10
10
|
|
|
11
11
|
<sub>Screenshot taken with simulated devices and traffic.</sub>
|
|
12
12
|
|
|
@@ -43,7 +43,7 @@ Ollama itself stays on `127.0.0.1`. Nothing outside the tunnel can talk to it.
|
|
|
43
43
|
- ask your ISP for a public IP;
|
|
44
44
|
- or relay through a small VPS.
|
|
45
45
|
|
|
46
|
-
See [Troubleshooting](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
46
|
+
See [Troubleshooting](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/getting-started.md#troubleshooting).
|
|
47
47
|
|
|
48
48
|
## Install
|
|
49
49
|
|
|
@@ -53,7 +53,7 @@ npx @ollamawg/cli version # or run it without installing
|
|
|
53
53
|
go install github.com/himanshu-mamgain/ollamawg/cmd/ollamawg@latest
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
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.2.
|
|
56
|
+
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.2.2/docs/deploy.md#docker).
|
|
57
57
|
|
|
58
58
|
## Quickstart
|
|
59
59
|
|
|
@@ -95,11 +95,11 @@ You can also use **Add device** in the dashboard, then **Phone**.
|
|
|
95
95
|
|
|
96
96
|
Ollama apps such as Enchanted or Reins work too: point them at `http://10.77.0.1:11434`.
|
|
97
97
|
|
|
98
|
-
<img src="https://raw.githubusercontent.com/himanshu-mamgain/ollamawg/v0.2.
|
|
98
|
+
<img src="https://raw.githubusercontent.com/himanshu-mamgain/ollamawg/v0.2.2/docs/images/chat.png" alt="The chat page on a phone" width="300">
|
|
99
99
|
|
|
100
100
|
<sub>Chat page on a phone, with a simulated model reply.</sub>
|
|
101
101
|
|
|
102
|
-
See [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
102
|
+
See [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/getting-started.md) for the full walkthrough.
|
|
103
103
|
|
|
104
104
|
## Features
|
|
105
105
|
|
|
@@ -156,19 +156,19 @@ Run `ollamawg <command> -h` for a command's flags.
|
|
|
156
156
|
|
|
157
157
|
| Guide | What's in it |
|
|
158
158
|
|---|---|
|
|
159
|
-
| [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
160
|
-
| [Configuration](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
161
|
-
| [Dashboard and admin API](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
162
|
-
| [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
163
|
-
| [Running as a service](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
164
|
-
| [Go library](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
159
|
+
| [Getting started](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/getting-started.md) | Install, set up a server, add laptops and phones, connect |
|
|
160
|
+
| [Configuration](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/configuration.md) | Every field in `server.yaml` and client configs, roles, model rules |
|
|
161
|
+
| [Dashboard and admin API](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/dashboard.md) | The UI, two-factor login, the HTTP API behind it, Prometheus metrics |
|
|
162
|
+
| [Security model](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/security.md) | What is protected, how, and what is not |
|
|
163
|
+
| [Running as a service](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/deploy.md) | systemd, launchd, Windows, Docker, port forwarding |
|
|
164
|
+
| [Go library](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/docs/library.md) | Embedding the server and client in your own programs |
|
|
165
165
|
|
|
166
166
|
## Limitations
|
|
167
167
|
|
|
168
168
|
- **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).
|
|
169
169
|
- **The dashboard has one admin account.** Put a reverse proxy with SSO in front if several people manage it.
|
|
170
170
|
- **Chat history lives in each device's browser.** It is not synced between devices or stored on the server.
|
|
171
|
-
- **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.2.
|
|
171
|
+
- **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.2.2/docs/security.md).
|
|
172
172
|
|
|
173
173
|
## Building from source
|
|
174
174
|
|
|
@@ -182,7 +182,7 @@ Go 1.24 or newer is required. Cross-compiling works out of the box, for example
|
|
|
182
182
|
|
|
183
183
|
## Releasing
|
|
184
184
|
|
|
185
|
-
Releases are cut from `main` by [`.github/workflows/publish.yml`](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
185
|
+
Releases are cut from `main` by [`.github/workflows/publish.yml`](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/.github/workflows/publish.yml):
|
|
186
186
|
|
|
187
187
|
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.
|
|
188
188
|
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.
|
|
@@ -191,4 +191,4 @@ A re-run finishes a release that stopped halfway.
|
|
|
191
191
|
|
|
192
192
|
## License
|
|
193
193
|
|
|
194
|
-
[MIT](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.
|
|
194
|
+
[MIT](https://github.com/himanshu-mamgain/ollamawg/blob/v0.2.2/LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ollamawg/cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Reach your Ollama server from anywhere through a user-space WireGuard tunnel, with per-device access control and a dashboard.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ollama",
|
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
"node": ">=16"
|
|
29
29
|
},
|
|
30
30
|
"optionalDependencies": {
|
|
31
|
-
"@ollamawg/darwin-arm64": "0.2.
|
|
32
|
-
"@ollamawg/darwin-x64": "0.2.
|
|
33
|
-
"@ollamawg/freebsd-x64": "0.2.
|
|
34
|
-
"@ollamawg/linux-arm64": "0.2.
|
|
35
|
-
"@ollamawg/linux-x64": "0.2.
|
|
36
|
-
"@ollamawg/win32-x64": "0.2.
|
|
31
|
+
"@ollamawg/darwin-arm64": "0.2.2",
|
|
32
|
+
"@ollamawg/darwin-x64": "0.2.2",
|
|
33
|
+
"@ollamawg/freebsd-x64": "0.2.2",
|
|
34
|
+
"@ollamawg/linux-arm64": "0.2.2",
|
|
35
|
+
"@ollamawg/linux-x64": "0.2.2",
|
|
36
|
+
"@ollamawg/win32-x64": "0.2.2"
|
|
37
37
|
}
|
|
38
38
|
}
|