@user/nginx/stream

Model type — v2026.02.14.1

Details

Type
@user/nginx/stream
Normalized
@user/nginx/stream
Version
v2026.02.14.1
Methods
2
Resources
2
Files
0
Definitions
1

Global Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sshHost": {
      "type": "string",
      "description": "SSH hostname for the proxy server"
    },
    "sshUser": {
      "default": "keeb",
      "description": "SSH user (default 'keeb')",
      "type": "string"
    },
    "streamDir": {
      "default": "~/stream",
      "description": "Path to stream proxy directory",
      "type": "string"
    }
  },
  "required": [
    "sshHost",
    "sshUser",
    "streamDir"
  ],
  "additionalProperties": false
}

Methods (2)

init

Bootstrap nginx stream proxy directory and start container

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
configure

Configure nginx stream proxy for a service

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "Service name used for config filename"
    },
    "targetIp": {
      "type": "string",
      "description": "Tailscale IP of the backend service"
    },
    "portMap": {
      "type": "string",
      "description": "Port mappings: 'listen:backend[/proto],...' e.g. '25565:25565,7777:7777/udp'"
    }
  },
  "required": [
    "vmName",
    "targetIp",
    "portMap"
  ],
  "additionalProperties": false
}

Resources (2)

server

Proxy server init result

Lifetime
infinite
Garbage Collection
10
proxy

Proxy configuration result

Lifetime
infinite
Garbage Collection
10

Definitions (1)

NameVersionTagsID
streamProxyv18a3efbfc