Skip to content

Server Options ​

Options of ordo-server. Every option can also be set with the environment variable shown. ordo-server --help prints the same list. For the ordo developer CLI, see CLI.

Listening ​

OptionEnvironmentDefaultWhat it does
--http-addrORDO_HTTP_ADDR0.0.0.0:8080HTTP address
-p, --portORDO_PORTHTTP port only. --http-addr wins if both are set
--grpc-addrORDO_GRPC_ADDR0.0.0.0:50051gRPC address
--grpc-portORDO_GRPC_PORTgRPC port only
--uds-pathORDO_UDS_PATHoffAlso serve gRPC on this Unix socket
--disable-httpORDO_DISABLE_HTTPTurn HTTP off
--disable-grpcORDO_DISABLE_GRPCTurn gRPC off

Rules on disk ​

OptionEnvironmentDefaultWhat it does
--rules-dirORDO_RULES_DIRmemory onlyLoad rules from this folder and save changes to it
--max-versionsORDO_MAX_VERSIONS10Old versions kept per rule
--watch-rulesORDO_WATCH_RULESoffReload files that change on disk
--wal-dirORDO_WAL_DIR<rules-dir>/walWrite-ahead log folder
--wal-disabledORDO_WAL_DISABLEDTurn the write-ahead log off. Writes are then not crash safe
--wal-max-segment-bytesORDO_WAL_MAX_SEGMENT_BYTES67108864Size at which a log segment is rotated
--wal-max-closed-segmentsORDO_WAL_MAX_CLOSED_SEGMENTS3Closed segments kept
--max-rules-per-tenantORDO_MAX_RULES_PER_TENANTno limitFurther creates get 422
--max-total-rulesORDO_MAX_TOTAL_RULESno limitSame, across all tenants

Several instances ​

See Deployment.

OptionEnvironmentDefaultWhat it does
--roleORDO_ROLEstandalonestandalone, writer or reader. Readers reject writes with 409
--writer-addrORDO_WRITER_ADDRWriter address, returned by readers in the 409
--nats-urlORDO_NATS_URLoffSync rule changes through NATS JetStream
--nats-subject-prefixORDO_NATS_SUBJECT_PREFIXordo.rulesSubject prefix for sync events
--instance-idORDO_INSTANCE_IDrandomUnique name of this instance for NATS

Access and limits ​

OptionEnvironmentDefaultWhat it does
--api-tokenORDO_API_TOKENoffHTTP data routes need Authorization: Bearer <token> or X-API-Token
--cors-allowed-originsORDO_CORS_ORIGINSnoneAllowed browser origins, comma-separated, or *
--max-concurrent-executionsORDO_MAX_CONCURRENT_EXECUTIONS0 (no limit)Requests in flight at once, HTTP and gRPC together
--request-timeout-secsORDO_REQUEST_TIMEOUT_SECS30HTTP requests that take longer get 408
--max-request-body-bytesORDO_MAX_REQUEST_BODY_BYTES10485760Largest request body, HTTP and gRPC
--shutdown-timeout-secsORDO_SHUTDOWN_TIMEOUT_SECS30How long shutdown waits for requests in flight
--grpc-tls-enabledORDO_GRPC_TLS_ENABLEDTLS for gRPC, with the two options below
--grpc-tls-certORDO_GRPC_TLS_CERTPEM certificate
--grpc-tls-keyORDO_GRPC_TLS_KEYPEM private key (PKCS8)
--grpc-mtls-enabledORDO_GRPC_MTLS_ENABLEDRequire client certificates. Implies TLS
--grpc-tls-client-caORDO_GRPC_TLS_CLIENT_CACA that signs client certificates

Tenants ​

OptionEnvironmentDefaultWhat it does
--multi-tenancy-enabledORDO_MULTI_TENANCY_ENABLEDoffSeparate rules and limits per X-Tenant-ID
--default-tenantORDO_DEFAULT_TENANTdefaultTenant for requests without the header
--default-tenant-qpsORDO_DEFAULT_TENANT_QPSno limitRequests per second for that tenant
--default-tenant-burstORDO_DEFAULT_TENANT_BURSTno limitBurst size for that tenant
--default-tenant-timeout-msORDO_DEFAULT_TENANT_TIMEOUT_MS100Execution timeout for that tenant
--tenants-dirORDO_TENANTS_DIR<rules-dir>/tenants/tenants.jsonFile where tenant settings are stored

Signed rules ​

See Signed rules.

OptionEnvironmentDefaultWhat it does
--signature-enabledORDO_SIGNATURE_ENABLEDoffCheck signatures
--signature-requireORDO_SIGNATURE_REQUIREoffReject unsigned rules, from the API and from files
--signature-trusted-keysORDO_SIGNATURE_TRUSTED_KEYSTrusted public keys, base64, comma-separated
--signature-trusted-keys-fileORDO_SIGNATURE_TRUSTED_KEYS_FILEThe same, one per line
--signature-allow-unsigned-localORDO_SIGNATURE_ALLOW_UNSIGNED_LOCALtrueLoad unsigned local files. Only the variable can turn it off: ORDO_SIGNATURE_ALLOW_UNSIGNED_LOCAL=false

Logs, audit and capture ​

OptionEnvironmentDefaultWhat it does
--log-levelORDO_LOG_LEVELinfotrace, debug, info, warn or error
--log-formatORDO_LOG_FORMATtexttext or json
--audit-dirORDO_AUDIT_DIRstdout onlyAlso write the audit log to daily files here
--audit-sample-rateORDO_AUDIT_SAMPLE_RATE10Percent of executions in the audit log
--capture-io-pathORDO_CAPTURE_IO_PATHoffRecord each execution's input and output, for ordo replay and ordo impact
--capture-io-sample-rateORDO_CAPTURE_IO_SAMPLE_RATE100Percent of executions recorded
--service-nameORDO_SERVICE_NAMEordo-serverService name in traces
--otlp-endpointORDO_OTLP_ENDPOINToffExport OpenTelemetry traces over OTLP HTTP, such as http://otel-collector:4318
--debug-modeORDO_DEBUG_MODEoffAdd the debug API. Not for production

Decision model gateway ​

See Decision Model Gateway.

OptionEnvironmentDefaultWhat it does
--decide-upstreamORDO_DECIDE_UPSTREAMoffSystem One compatible API to forward to. Turns the gateway on
--decide-api-keyORDO_DECIDE_API_KEYKey sent upstream. Without it the caller's Authorization is forwarded. Needed with --api-token
--decide-log-dirORDO_DECIDE_LOG_DIRoffWrite the decision log here
--decide-log-requestsORDO_DECIDE_LOG_REQUESTSoffAlso log each request's state and questions

Platform ​

See Engines.

OptionEnvironmentDefaultWhat it does
--platform-urlORDO_PLATFORM_URLPlatform to register with
--server-tokenORDO_SERVER_TOKENUnique token of this engine. Needed to register
--platform-connect-tokenORDO_CONNECT_TOKENPuts the engine in an organization
--platform-registration-secretORDO_PLATFORM_REGISTRATION_SECRETPlatform-wide secret, when not using connect tokens
--server-nameORDO_SERVER_NAMEordo-serverName shown in the platform
--server-urlORDO_SERVER_URLhttp://<http-addr>Address the platform uses to reach this engine
--stats-interval-secsORDO_STATS_INTERVAL_SECS15How often execution stats are sent to the platform

Signing tools ​

cargo build --release also builds ordo-keygen, ordo-sign and ordo-verify:

bash
ordo-keygen --output ./keys
ordo-sign --key ./keys/private.key --input rule.json [--output rule.signed.json]
ordo-verify --key ./keys/public.key --input rule.signed.json

Released under the MIT License.