ordinaryd 0.7.0

.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH ordinaryd-api 1  "api 0.7.0" 
.SH NAME
ordinaryd\-api \- start the Ordinary API server
.SH SYNOPSIS
\fBordinaryd api\fR [\fB\-\-environment\fR] <\fB\-\-storage\-size\fR> [\fB\-\-provision\fR] [\fB\-\-data\-dir\fR] [\fB\-\-port\fR] [\fB\-\-redirect\-port\fR] [\fB\-\-stored\-logs\fR] [\fB\-\-insecure\fR] [\fB\-\-stdio\-logs\fR] [\fB\-\-insecure\-cookies\fR] [\fB\-\-stdio\-logs\-fmt\fR] [\fB\-\-journald\-logs\fR] [\fB\-\-log\-ttl\-hours\fR] [\fB\-\-log\-level\fR] [\fB\-\-log\-rotation\-file\-size\fR] [\fB\-\-log\-rotation\-mins\fR] [\fB\-\-log\-sizes\fR] [\fB\-\-log\-headers\fR] [\fB\-\-stdio\-logs\-timing\fR] [\fB\-\-log\-ips\fR] [\fB\-\-redacted\-header\-hash\fR] [\fB\-\-danger\-dns\-no\-verify\fR] [\fB\-\-dedicated\-ports\fR] [\fB\-\-swagger\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] 
.SH DESCRIPTION
start the Ordinary API server
.SH OPTIONS
.TP
\fB\-\-environment\fR \fI<ENVIRONMENT>\fR [default: staging]
environment (e.g production, development, staging)
.TP
\fB\-\-storage\-size\fR \fI<STORAGE_SIZE>\fR
Storage size in bytes (rounded up to nearest OS page size)
.TP
\fB\-\-provision\fR \fI<PROVISION>\fR [default: localhost]
what mode TLS certs should be provisioned in
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
staging
.IP \(bu 2
production
.IP \(bu 2
localhost
.RE
.TP
\fB\-\-data\-dir\fR \fI<DATA_DIR>\fR [default: ~/.ordinary]
specify the data directory
.TP
\fB\-\-port\fR \fI<PORT>\fR
specify HTTP(s) port for server
.TP
\fB\-\-redirect\-port\fR \fI<REDIRECT_PORT>\fR
specify HTTP port for server when running in secure mode
.TP
\fB\-\-stored\-logs\fR
persists JSON formatted log lines to <data\-dir>/logs/<domain>/
.TP
\fB\-\-insecure\fR
run without HTTPS
.TP
\fB\-\-stdio\-logs\fR
logs events to stdio
.TP
\fB\-\-insecure\-cookies\fR
run with insecure cookies
.TP
\fB\-\-stdio\-logs\-fmt\fR \fI<STDIO_LOGS_FMT>\fR [default: json]
how to format stdio logs
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
concise
.IP \(bu 2
pretty
.IP \(bu 2
json
.RE
.TP
\fB\-\-journald\-logs\fR
logs events to `journald` (only works on Linux distros that use `systemd`)
.TP
\fB\-\-log\-ttl\-hours\fR \fI<LOG_TTL_HOURS>\fR [default: 72]
max period of time logs are stored
.TP
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR [default: info]
base log level for every component
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
error
.IP \(bu 2
warn
.IP \(bu 2
info
.IP \(bu 2
debug
.IP \(bu 2
trace
.RE
.TP
\fB\-\-log\-rotation\-file\-size\fR \fI<LOG_ROTATION_FILE_SIZE>\fR [default: 10000000]
max size (in bytes) per log file
.TP
\fB\-\-log\-rotation\-mins\fR \fI<LOG_ROTATION_MINS>\fR [default: 60]
max amount of time a log file is appended to before being compressed and stored
.TP
\fB\-\-log\-sizes\fR
whether storage and certain payload sizes are logged
.TP
\fB\-\-log\-headers\fR
whether HTTP request and response headers are logged
.TP
\fB\-\-stdio\-logs\-timing\fR
whether span timing is logged
.TP
\fB\-\-log\-ips\fR
whether IP Addresses are logged with HTTP requests
.TP
\fB\-\-redacted\-header\-hash\fR \fI<REDACTED_HEADER_HASH>\fR [default: none]
"none" | "blake2" | "blake3"
.TP
\fB\-\-danger\-dns\-no\-verify\fR
set to `true` to bypass verification of proxy domain and CNAME DNS TXT records.

**IMPORTANT**: should ONLY be used for local development and testing.
.TP
\fB\-\-dedicated\-ports\fR
give each app its own port
.TP
\fB\-\-swagger\fR
Storage size in bytes (rounded up to nearest OS page size)
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
.SH VERSION
v0.7.0