Skip to main content

Crate ordinaryd

Crate ordinaryd 

Source
Expand description

§Command-Line Help for ordinaryd

This document contains the help content for the ordinaryd command-line program.

Command Overview:

§ordinaryd

Ordinary Server

Usage: ordinaryd [OPTIONS]

§Options:
  • --init — whether a multi-domain project should be initialized

    Default value: false

  • --environment <ENVIRONMENT> — environment (e.g production, development, staging)

    Default value: staging

  • --admin-domain <ADMIN_DOMAIN> — domain name for admin console

  • --admin-contacts <ADMIN_CONTACTS> — contacts for the admin domain cert provisioning

  • --dedicated-ports — give each app its own port

    Default value: false

  • --domain-override <DOMAIN_OVERRIDE> — use a different domain than the config

  • --user <USER> — user to run the instance under

    Default value: root

  • --password <PASSWORD> — instance user password

    Default value: password

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

    Default value: false

  • --data-dir <DATA_DIR> — specify the data directory

    Default value: ./.ordinary

  • --project-dir <PROJECT_DIR> — for running a standalone project. (project must already be built)

  • --insecure — run without HTTPS

    Default value: false

  • --insecure-cookies — run with insecure cookies

    Default value: false

  • --provision <PROVISION> — what mode TLS certs should be provisioned in

    Default value: localhost

    Possible values: staging, production, localhost

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

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

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

  • --stdio-logs — logs events to stdio

    Default value: false

  • --stdio-pretty — whether to pretty print stdio logs

    Default value: false

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

    Default value: false

  • --json-logs — persists JSON formatted log lines to /logs/

    Default value: false

  • --log-level <LOG_LEVEL> — base log level for every component

    Default value: info

    Possible values: error, warn, info, debug, trace

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

    Default value: false

  • --log-file-rotation <LOG_FILE_ROTATION> — rate at which new log files are generated

    Default value: minute

    Possible values: day, hour, minute, never

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

    Default value: false

  • --redacted-header-hash <REDACTED_HEADER_HASH>

    Default value: none

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

    Default value: false

  • --log-size — whether storage sizes are logged

    Default value: false

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

    Default value: false

  • --log-sync-interval-min <LOG_SYNC_INTERVAL_MIN> — min duration between log indexing operations. (seconds)

    Default value: 15

  • --log-sync-interval-max <LOG_SYNC_INTERVAL_MAX> — duration between log indexing operations. (seconds)

    Default value: 45

  • --log-max-ttl-days <LOG_MAX_TTL_DAYS> — max period of time logs are indexed/stored

    Default value: 7


This document was generated automatically by clap-markdown.

Structs§

Cli

Enums§

LogFileRotation
LogLevel
ProvisionMode

Functions§

run
setup