oroc push server
Run a local UnifiedPush development server backed by ntfy.
Usage#
oroc push server [options]
Options#
| Option | Description |
|---|---|
--host=<ip> |
listen address (default: 127.0.0.1) |
--port=<port> |
listen port (default: 8787) |
--base-url=<origin> |
URL reachable by the distributor and application server |
--data-dir=<path> |
writable cache, tools and message storage directory |
--cert-file=<path> |
PEM certificate for direct HTTPS (requires --key-file) |
--key-file=<path> |
PEM private key for direct HTTPS (requires --cert-file) |
--ntfy-bin=<path> |
use an explicitly supplied ntfy executable without download |
--offline |
require the verified cached ntfy release or --ntfy-bin |
-h, --help |
show help |
Notes#
Requires Node.js 22 or later. On first use, downloads ntfy 2.33.1 from its official GitHub release and verifies a pinned SHA-256. Later starts use the verified cache.
Automatic installation supports Linux x64/arm64 and Windows x64. On macOS, use --ntfy-bin with a server-enabled development build; upstream's macOS release is client-only.
State defaults to the user's Oro data directory, outside the installed SDK.
The server runs in the foreground; Ctrl-C stops it. Cached messages expire after 12 hours.
This is an anonymous development server. Use public test data and private development networks.
No FCM, upstream push relay or system ntfy configuration is used.
Use 'push distributor' to build Oro Push Dev, or install the Android ntfy distributor.
Configure the selected distributor with this base URL; both use the same server.
LAN binding requires an explicit HTTPS base URL. Supply a certificate trusted by the distributor, or terminate HTTPS with a local reverse proxy. HTTP loopback is for host checks; Oro Android push registration requires HTTPS endpoints and encrypted Web Push payloads.
Application-server authentication, endpoint enrollment and notification handling remain app work.
See https://docs.ntfy.sh/config/ and https://unifiedpush.org/users/distributors/.
Examples#
oroc push server
start at http://127.0.0.1:8787
oroc push server --offline
restart from the verified cached release
oroc push server --host=0.0.0.0 --base-url=https://push.dev.example:8787 --cert-file=./cert.pem --key-file=./key.pem
serve HTTPS on port 8787 for an Android distributor
oroc push server --base-url=https://push.dev.example
run loopback HTTP behind a local HTTPS reverse proxy
Source repository · Edit this page · View Markdown