ordinaryd 0.5.47

Ordinary Server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# Command-Line Help for `ordinaryd`

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

**Command Overview:**

* [`ordinaryd`↴](#ordinaryd)

## `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 <data-dir>/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`



<hr/>

<small><i>
    This document was generated automatically by
    <a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
</i></small>