CLI / oroc update server

oroc update server

Run an update server that speaks the Oro Application Update Protocol.

Usage#

oroc update server [options]

Options#

Option Description
--root=<dir> directory containing manifest trees and artifacts to serve
--host=<host> interface to bind (default: 0.0.0.0)
--port=<port> TCP/UDP port to bind (default: 8080)
--manifest-name=<name> manifest filename to look up under each appId (default: manifest.json or ORO_UPDATE_MANIFEST_FILENAME)
--tcp run in TCP mode (binary OUP CHECK/RESPONSE)
--udp run in UDP mode (binary OUP CHECK/RESPONSE)
--log-file=<path> mirror logs to a JSON file
-h, --help show help

Notes#

Default mode is HTTP. The server exposes these endpoints.

  • GET /health — readiness metadata
  • POST /check — accepts a CHECK JSON payload with "appId" and responds with a RESPONSE JSON whose manifestUrl points at "/<appId>/<manifest-name>" when present
  • GET /<path> — serves files rooted under --root, including "<appId>/<manifest-name>" and "<appId>/<manifest-name>.sig" HTTP mode is designed to be run behind a load balancer or reverse proxy in production.

TCP and UDP modes implement the same CHECK/RESPONSE selection semantics using the binary OUP framing.

Examples#

oroc update server --root ./updates

serve manifests and bundles over HTTP on port 8080

oroc update server --root ./updates --tcp --port 9090

run a TCP OUP server on port 9090

oroc update server --root ./updates --udp --port 9090

run a UDP OUP server on port 9090

Source repository · Edit this page · View Markdown

Quick links

Type to search across the site. Use the up and down arrow keys to choose a result, Enter to open it, and Escape to close.