Server Parameters Guidelines

On this page

Startup and Runtime Support

Example

When you document a new server parameter, include the following details in addition to specific information about the new parameter. Document these details in the order they appear in the following table:

Documentation Detail	Necessity	Description
`mongod` / `mongos` Support	Required	Whether the parameter is supported on `mongod`, `mongos`, or both. Use the `\|mongod-only\|`, `\|mongos-only\|`, or `\|both\|` substitutions as appropriate.
Version the Parameter was Added or Changed In	Conditional	For recent versions, include the version the parameter was added or changed in. For archived versions, delete the version added tag.
OS Availability	Optional	Some parameters are available only on certain operating systems. If the parameter is supported only on certain operating systems, specify which it's supported on.
Argument Type	Required	Type of argument the parameter expects: integer, string, boolean, document, and so on.
Default Value	Required	Specify the default value of the parameter.
Startup and Runtime Support	Required	Specify whether the parameter is supported at startup, runtime, or both. For details, see Startup and Runtime Support.

Startup and Runtime Support

You can use the provided includes to document startup and/or runtime support.

To specify that the parameter is supported only at startup, use the following include:

.. include:: /includes/fact-startup-parameter

To specify that the parameter is supported only at runtime, use the following include:

.. include:: /includes/fact-runtime-parameter

To specify that the parameter is supported both at startup and during runtime, use the following include:

.. include:: /includes/fact-runtime-startup-parameter

Example

The following screenshot shows the documentation for the tlsUseSystemCA parameter.

The following table describes the details that the tlsUseSystemCA section documents:

Documentation Detail	Necessity	Example in tlsUseSystemCA
`mongod` / `mongos` Support	Required	Supported on `mongod` only
Version the Parameter was Added or Changed In	Conditional	Not applicable
OS Availability	Optional	Not applicable
Argument Type	Required	boolean
Default Value	Required	false
Startup and Runtime Support	Required	`tlsUseSystemCA` is available at startup, but not runtime.

Back

Reference Page Prototype

Task Page Prototype