tide-commander 0.83.0 → 0.84.0

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 CHANGED
@@ -57,8 +57,31 @@ tide-commander --foreground
57
57
  tide-commander logs --lines 200
58
58
  tide-commander --port 8080 --host 0.0.0.0
59
59
  tide-commander --listen-all --port 8080
60
+ tide-commander --https --tls-key ./certs/localhost-key.pem --tls-cert ./certs/localhost.pem
61
+ tide-commander --install-local-cert --https
60
62
  ```
61
63
 
64
+ To generate and trust a local certificate automatically (requires `mkcert`):
65
+
66
+ ```bash
67
+ tide-commander start --install-local-cert --https
68
+ ```
69
+
70
+ ## 🔒 HTTPS Security
71
+
72
+ Use HTTPS/WSS whenever Tide Commander is reachable beyond localhost, especially on shared networks.
73
+
74
+ - Enable HTTPS with existing cert files: `tide-commander start --https --tls-key ./certs/localhost-key.pem --tls-cert ./certs/localhost.pem`
75
+ - Generate and install a trusted local cert with `mkcert`: `tide-commander start --install-local-cert --https`
76
+ - Set an auth token explicitly: `tide-commander start --https --auth-token <your-token>`
77
+ - Generate a secure auth token automatically: `tide-commander start --https --generate-auth-token`
78
+ - For development UI over HTTPS, set `DEV_HTTPS=1` and provide `DEV_TLS_KEY_PATH` + `DEV_TLS_CERT_PATH`.
79
+
80
+ Notes:
81
+ - Local certs are stored in `~/.tide-commander/certs/` when using `--install-local-cert`.
82
+ - `--generate-auth-token` prints the generated token at startup; save it in a secure password manager.
83
+ - If `AUTH_TOKEN` is configured, keep using it with HTTPS for transport encryption plus access control.
84
+
62
85
  ## 🧑‍💻 Development Setup
63
86
 
64
87
  Use this only if you are developing Tide Commander itself:
@@ -71,7 +94,7 @@ bun install
71
94
  bun run dev
72
95
  ```
73
96
 
74
- Open http://localhost:5173 in your browser (or your configured `VITE_PORT`).
97
+ Open `http://localhost:5173` in your browser (or `https://localhost:5173` when `DEV_HTTPS=1`).
75
98
 
76
99
  ## 💡 Why Tide Commander?
77
100
 
@@ -357,6 +380,12 @@ Configuration via environment variables (see `.env.example`):
357
380
  | `TIDE_SERVER` | `http://localhost:$PORT` | Server URL for hooks |
358
381
  | `LISTEN_ALL_INTERFACES` | _(unset)_ | Set to `1` to listen on 0.0.0.0 instead of localhost |
359
382
  | `AUTH_TOKEN` | _(unset)_ | Token for authenticating WebSocket and HTTP connections |
383
+ | `HTTPS` | _(unset)_ | Set to `1` to serve backend over HTTPS/WSS |
384
+ | `TLS_KEY_PATH` | `~/.tide-commander/certs/localhost-key.pem` | TLS private key path for backend HTTPS |
385
+ | `TLS_CERT_PATH` | `~/.tide-commander/certs/localhost.pem` | TLS certificate path for backend HTTPS |
386
+ | `DEV_HTTPS` | _(unset)_ | Set to `1` to run Vite dev server over HTTPS |
387
+ | `DEV_TLS_KEY_PATH` | _(unset)_ | TLS private key path for Vite dev HTTPS |
388
+ | `DEV_TLS_CERT_PATH` | _(unset)_ | TLS certificate path for Vite dev HTTPS |
360
389
 
361
390
  ## 🛠️ Development
362
391