orke remote setup

Set up direct HTTPS access by IP address.

Command referenceEnglish

When to use it

Configure the port and certificate for direct HTTPS access using a public IPv4 address. First start orke and link your Google account with orke login.

Usage

View settings · Make changes · Certificates

orke remote setup
orke remote setup --port 48650 --enable
orke remote setup --disable
orke remote setup --certificate /absolute/path/orke.pfx --ip PUBLIC_IPV4
orke remote setup --automatic-certificate --agree-ca-terms --http-port 48880 --port 48650 --enable
orke remote setup --renew-certificate
orke remote setup --manual-certificate

Options

--port: 1–65535, excluding internal ports 47620–48643 and support port 48700. Default: 48650.
--enable / --disable: Enable or disable the external endpoint.
--certificate and --ip: The absolute PFX path and the certificate’s public IPv4 address. The PFX must be no larger than 16 MiB.
--password-stdin: Read the password from standard input. If omitted, enter it hidden in an interactive terminal. Do not put passwords in argv.
--automatic-certificate and --agree-ca-terms: orke obtains a public IPv4 certificate from Let's Encrypt and renews it before expiry. Use only if you agree to the current subscriber agreement shown by the command.
--http-port: The local port for Let's Encrypt HTTP validation. 80 or 1024–65535 (excluding internal ports 47620–48643, support port 48700, and the HTTPS port); default: 80. External TCP port 80 must reach this port.
--renew-certificate: Request immediate renewal of the automatically managed certificate.
--manual-certificate: Turn off automatic management. Import certificates manually afterward.

Behavior and states to watch for

On Windows, changes and imports apply to the running App or orke serve. On Linux and macOS, settings can also be saved while orke is stopped. Use the same user and ORKE_HOME. Replacing a certificate, changing the port, or disabling access ends existing remote connections, but tasks continue. An address or waiting-for-connection state does not prove that external connections succeed. Automatic certificate options (--automatic-certificate·--renew-certificate·--manual-certificate) require a running orke and sign-in.

You must configure your router and firewall in all cases. If importing a certificate yourself, prepare a trusted IP certificate, private key, and chain, and reimport the renewed PFX before expiry. Certificate issuance and renewal guide →