.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH ordinaryd-init 1 "init 0.8.2"
.SH NAME
ordinaryd\-init \- initialize the environment for an Ordinary API server
.SH SYNOPSIS
\fBordinaryd init\fR [\fB\-\-environment\fR] <\fB\-\-storage\-size\fR> <\fB\-\-api\-domain\fR> [\fB\-\-data\-dir\fR] [\fB\-\-password\fR] [\fB\-\-mfa\-stored\fR] [\fB\-\-stored\-logs\fR] [\fB\-\-api\-contacts\fR] [\fB\-\-stdio\-logs\fR] [\fB\-\-app\-domains\fR] [\fB\-\-stdio\-logs\-fmt\fR] [\fB\-\-journald\-logs\fR] [\fB\-\-privileged\-domains\fR] [\fB\-\-log\-level\fR] [\fB\-\-log\-sizes\fR] [\fB\-\-stdio\-logs\-timing\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
.SH DESCRIPTION
initialize the environment for an 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\-\-api\-domain\fR \fI<API_DOMAIN>\fR
domain name for API console
.TP
\fB\-\-data\-dir\fR \fI<DATA_DIR>\fR [default: ~/.ordinary]
specify the data directory
.TP
\fB\-\-password\fR \fI<PASSWORD>\fR [default: password]
instance user password
.TP
\fB\-\-mfa\-stored\fR
store the MFA key locally instead of copying a QR code
.TP
\fB\-\-stored\-logs\fR
persists JSON formatted log lines to <data\-dir>/logs/<domain>/
.TP
\fB\-\-api\-contacts\fR \fI<API_CONTACTS>...\fR
contacts for the API domain cert provisioning
.TP
\fB\-\-stdio\-logs\fR
logs events to stdio
.TP
\fB\-\-app\-domains\fR \fI<APP_DOMAINS>...\fR
domains that apps can subdomain off of.
i.e. when `example.com` is passed, `my.example.com` is considered a valid app domain.
.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\-\-privileged\-domains\fR [\fI<PRIVILEGED_DOMAINS>...\fR]
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.
.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\-sizes\fR
whether storage and certain payload sizes are logged
.TP
\fB\-\-stdio\-logs\-timing\fR
whether span timing is logged
.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.8.2