Function StartRelayProxy

StartRelayProxy(
dirOrFile: string,
logger?: ILoggingAgent,
): Promise<IRelayProxyInstance>
Start a relay-mode proxy from a configuration file, mirroring StartProxy.

dirOrFile may be a directory or a file path:
- Directory: looks for kaven-relay-proxy.config inside it, writing a default DEFAULT_RELAY_PROXY_CONFIG the first time so it can be edited, then loads it.
- File: loads that file directly.
The loaded IRelayProxyConfig is resolved into IStartRelayProxyOptions via ResolveRelayProxyConfig and passed to StartRelayProxyCore.
Parameters
- dirOrFile: string
  Directory or config file to load. Defaults to the current working directory.
- Optionallogger: ILoggingAgent
  Optional logger.
Returns Promise<IRelayProxyInstance>
Example
```
// write/edit ./kaven-relay-proxy.config, then:
const proxy = await StartRelayProxy("./", logger);
```
Since
6.1.8

Version
2026-07-27
- Defined in src/KavenUtility.RelayProxy.ts:268