oh-my-pr 4.4.0 → 4.5.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
@@ -99,6 +99,20 @@ oh-my-pr can be used in a few ways:
99
99
  - local REST API: see [LOCAL_API.md](LOCAL_API.md)
100
100
  - optional Tauri desktop shell
101
101
 
102
+ Local browser and API access work without a dashboard login. To use the web
103
+ dashboard from another machine, set remote web credentials before starting the
104
+ server:
105
+
106
+ ```bash
107
+ OH_MY_PR_WEB_USERNAME=operator \
108
+ OH_MY_PR_WEB_PASSWORD='choose-a-long-password' \
109
+ OH_MY_PR_SESSION_SECRET='choose-a-long-random-secret' \
110
+ oh-my-pr
111
+ ```
112
+
113
+ Remote API requests then require a signed dashboard session. Put TLS in front
114
+ of the server before using remote access over an untrusted network.
115
+
102
116
  ### Logging
103
117
 
104
118
  Server output is structured (pino) and goes to two destinations by default:
@@ -158,7 +172,9 @@ npm install
158
172
  npm run dev
159
173
  ```
160
174
 
161
- The dashboard is available at `http://localhost:5001` by default. All `/api/*` routes are restricted to loopback callers.
175
+ The dashboard is available at `http://localhost:5001` by default. Loopback API
176
+ requests work without login; remote dashboard/API access requires
177
+ `OH_MY_PR_WEB_USERNAME` and `OH_MY_PR_WEB_PASSWORD`.
162
178
 
163
179
  ## Docs
164
180