Edit existing documentation 📝

Page to edit

/reference/server-configuration

Required changes

Improve reference documentation for the server_config.json file. Use jsonschema2md to generate markdown documentation for the server_config.json. Note that some elements from the markdown will need to be manually removed (see /reference/payloads/ransomware and /reference/payloads/cryptojacker for an example). You can use the script shown below under "Resources" to dump the plugin's Pydantic options model to JSON. You may need to add details, such as descriptions, to the Pydantic model.

Resources

jsonschema2md
Diátaxis

import json
from src.<PLUGIN>_options import <PLUGIN>Options

print(json.dumps(<PLUGIN>Options.model_json_schema(), indent=2))