ordinaryd-init(1)

NAME
ordinaryd-init - initialize the environment for an Ordinary API server

SYNOPSIS
ordinaryd init [--environment] <--storage-size> <--api-domain> [--data-dir] [--password] [--mfa-stored] [--stdio-logs] [--api-contacts] [--stdio-pretty] [--app-domains] [--stdio-json] [--json-logs] [--privileged-domains] [--log-level] [--with-span-timing] [--log-file-rotation] [--log-size] [-h|--help] [-V|--version]

DESCRIPTION
initialize the environment for an 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)

--api-domain <API_DOMAIN>
    domain name for API console

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

--password <PASSWORD> [default: password]
    instance user password

--mfa-stored
    store the MFA key locally instead of copying a QR code

--stdio-logs
    logs events to stdio

--api-contacts <API_CONTACTS>...
    contacts for the API domain cert provisioning

--stdio-pretty
    whether to pretty print stdio logs

--app-domains <APP_DOMAINS>...
    domains that apps can subdomain off of. i.e. when `example.com` is passed, `my.example.com` is considered a valid app domain.

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

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

--privileged-domains [<PRIVILEGED_DOMAINS>...]
    list of applications that have access to API server level commands (i.e. API server invite token generation) currently intended to enable API server admins to set up a web-based registration portal.

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

    •   error

    •   warn

    •   info

    •   debug

    •   trace

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

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

    •   day

    •   hour

    •   minute

    •   never

--log-size
    whether storage sizes are logged

-h, --help
    Print help (see a summary with '-h')

-V, --version
    Print version

VERSION
v0.6.0-pre.8