dtoro
d4d99a7473
Problem: the hexagonal refactor churns the backend tree for nine more phases; the UI delivery stack (web/ SPA, cmd/desktop Wails wrapper, compose/web image) must move to its own repo first so doc/layout rewrites land once on a backend-only tree. Change: - New repo git.hubris.network/dtoro/oikos-web (v0.33.0): web/, desktop/ (updateURL repointed to oikos-web releases), compose/, own CI (web + desktop jobs), own deploy script (CI-green gate, TOCTOU guard, version-tagged images, prune-to-3), own webhook receiver on :9798 + launchd unit, own compose project publishing the same 8091:80. - Cutover executed on mac-mini in order: oikos stack's web service stopped+removed, oikos-web project brought up on 8091; outer Caddy untouched (targets the published port) — serving + Authentik flow + /wails 404 quirk verified post-cutover. - Stripped from oikos: web/, cmd/desktop/, compose/web/, desktop CI workflow, ci.yml web job, Makefile ui/desktop/desktop-package/install targets, the compose web service, oikos-web from deploy.sh's fallback prune list; wails + go-keyring dropped from go.mod, vendor synced. - README / CONTRIBUTING / AGENTS.md / .agents dev+operations docs now point at the new repo; mbse + mascot design docs carry a path note. Risk: production SPA serving depends on the new pipeline now; rollback is versioned-image re-up of the old web service from a pre-split checkout (port 8091). Desktop builds installed before the split still check dtoro/oikos releases — one manual reinstall, noted in the oikos-web release notes. Verification: go vet, make test (race), make generate-check, golangci (no new findings; baseline down 400→365); post-cutover curls — localhost:8091 200, /wails/runtime.js 404, outer Caddy 302 Authentik.
71 lines
2.1 KiB
Markdown
71 lines
2.1 KiB
Markdown
https-proxy-agent
|
|
================
|
|
### An HTTP(s) proxy `http.Agent` implementation for HTTPS
|
|
|
|
This module provides an `http.Agent` implementation that connects to a specified
|
|
HTTP or HTTPS proxy server, and can be used with the built-in `https` module.
|
|
|
|
Specifically, this `Agent` implementation connects to an intermediary "proxy"
|
|
server and issues the [CONNECT HTTP method][CONNECT], which tells the proxy to
|
|
open a direct TCP connection to the destination server.
|
|
|
|
Since this agent implements the CONNECT HTTP method, it also works with other
|
|
protocols that use this method when connecting over proxies (i.e. WebSockets).
|
|
See the "Examples" section below for more.
|
|
|
|
Examples
|
|
--------
|
|
|
|
#### `https` module example
|
|
|
|
```ts
|
|
import * as https from 'https';
|
|
import { HttpsProxyAgent } from 'https-proxy-agent';
|
|
|
|
const agent = new HttpsProxyAgent('http://168.63.76.32:3128');
|
|
|
|
https.get('https://example.com', { agent }, (res) => {
|
|
console.log('"response" event!', res.headers);
|
|
res.pipe(process.stdout);
|
|
});
|
|
```
|
|
|
|
#### `ws` WebSocket connection example
|
|
|
|
```ts
|
|
import WebSocket from 'ws';
|
|
import { HttpsProxyAgent } from 'https-proxy-agent';
|
|
|
|
const agent = new HttpsProxyAgent('http://168.63.76.32:3128');
|
|
const socket = new WebSocket('ws://echo.websocket.org', { agent });
|
|
|
|
socket.on('open', function () {
|
|
console.log('"open" event!');
|
|
socket.send('hello world');
|
|
});
|
|
|
|
socket.on('message', function (data, flags) {
|
|
console.log('"message" event! %j %j', data, flags);
|
|
socket.close();
|
|
});
|
|
```
|
|
|
|
API
|
|
---
|
|
|
|
### new HttpsProxyAgent(proxy: string | URL, options?: HttpsProxyAgentOptions)
|
|
|
|
The `HttpsProxyAgent` class implements an `http.Agent` subclass that connects
|
|
to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket
|
|
requests. This is achieved by using the [HTTP `CONNECT` method][CONNECT].
|
|
|
|
The `proxy` argument is the URL for the proxy server.
|
|
|
|
The `options` argument accepts the usual `http.Agent` constructor options, and
|
|
some additional properties:
|
|
|
|
* `headers` - Object containing additional headers to send to the proxy server
|
|
in the `CONNECT` request.
|
|
|
|
[CONNECT]: http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling
|