ordinaryd-api(1)

NAME
ordinaryd-api - start the Ordinary API server

SYNOPSIS
ordinaryd api [--environment] <--storage-size> [--provision] [--data-dir] [--port] [--redirect-port] [--stdio-logs] [--insecure] [--stdio-pretty] [--insecure-cookies] [--stdio-json] [--json-logs] [--log-headers] [--log-ips] [--log-level] [--redacted-header-hash] [--with-span-timing] [--dedicated-ports] [--log-file-rotation] [--log-index] [--log-size] [--log-sync-interval-min] [--log-sync-interval-max] [--log-max-ttl-days] [--swagger] [-h|--help] [-V|--version]

DESCRIPTION
start the Ordinary API server

OPTIONS

--environment <ENVIRONMENT> [default: staging]
    environment (e.g production, development, staging)

--storage-size <STORAGE_SIZE>
    Storage size in bytes (rounded up to nearest OS page size)

--provision <PROVISION> [default: localhost]
    what mode TLS certs should be provisioned in
    Possible values:

    •   staging

    •   production

    •   localhost

--data-dir <DATA_DIR> [default: ~/.ordinary]
    specify the data directory

--port <PORT>
    specify HTTP(s) port for server

--redirect-port <REDIRECT_PORT>
    specify HTTP port for server when running in secure mode

--stdio-logs
    logs events to stdio

--insecure
    run without HTTPS

--stdio-pretty
    whether to pretty print stdio logs

--insecure-cookies
    run with insecure cookies

--stdio-json
    whether to print stdio logs as json

--json-logs
    persists JSON formatted log lines to <data-dir>/logs/

--log-headers
    whether HTTP request and response headers are logged

--log-ips
    whether IP Addresses are logged with HTTP requests

--log-level <LOG_LEVEL> [default: info]
    base log level for every component
    Possible values:

    •   error

    •   warn

    •   info

    •   debug

    •   trace

--redacted-header-hash <REDACTED_HEADER_HASH> [default: none]
    "none" | "blake2" | "blake3"

--with-span-timing
    dictates whether timing information should be logged

--dedicated-ports
    give each app its own port

--log-file-rotation <LOG_FILE_ROTATION> [default: minute]
    rate at which new log files are generated
    Possible values:

    •   day

    •   hour

    •   minute

    •   never

--log-index
    whether to index logs so they can be queried

--log-size
    whether storage sizes are logged

--log-sync-interval-min <LOG_SYNC_INTERVAL_MIN> [default: 15]
    min duration between log indexing operations. (seconds)

--log-sync-interval-max <LOG_SYNC_INTERVAL_MAX> [default: 45]
    duration between log indexing operations. (seconds)

--log-max-ttl-days <LOG_MAX_TTL_DAYS> [default: 7]
    max period of time logs are indexed/stored

--swagger
    Storage size in bytes (rounded up to nearest OS page size)

-h, --help
    Print help

-V, --version
    Print version

VERSION
v0.6.0-pre.8