mirror of
https://github.com/sysadminsmedia/homebox.git
synced 2025-12-21 13:23:14 +01:00
b8f7ce7eb2
* doc fix: match configure option names with help message (1/2) This is a first commit in an attempt to reconcile the differences between the /en/configure/index doc page and the automatically generated help message. This addresses typos including, though not limited to, Discussion #954, titled "[doc] apparent typo in the documentation of GitHub release check option". This commit fixes the CLI help command, preserving the original order, while manually matching the option names with the help message generated by the backend api executable. Options are only checked for spelling correctness and existence. In particular, the following are removed because i could not find them in the help message. * --swagger-host/$HBOX_SWAGGER_HOST <string> (default: localhost:7745) * --swagger-scheme/$HBOX_SWAGGER_SCHEME <string> (default: http) The following default values have also been updated: * --storage-conn-string/$HBOX_STORAGE_CONN_STRING (a slash is added to the URI path) * --database-sqlite-path/$HBOX_DATABASE_SQLITE_PATH (a query param '&_time_format=sqlite' is added) * --database-ssl-mode/$HBOX_DATABASE_SSL_MODE (default 'prefer' added) * doc fix: match configure option names with help message (2/2) This is a second commit in an attempt to reconcile the differences between the /en/configure/index doc page and the automatically generated help message. See the previous commit for details. This commit fixes the Markdown table. Options are only checked for spelling correctness and existence. The following rows are deleted in particular: * HBOX_SWAGGER_HOST * HBOX_SWAGGER_SCHEME The following default values are updated: * HBOX_STORAGE_CONN_STRING (a slash is added to the URI path) * HBOX_DATABASE_SQLITE_PATH (a query param '&_time_format=sqlite' is added) * HBOX_DATABASE_SSL_MODE (default 'prefer' added)