Document new gramps-web-api server flags #28
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds docs for new server flags:
To send the log data to a file, use
--log-file FILENAME
. The default is not to log to a file.To set the log level (for console or file) use
--debug-level LEVEL
where LEVEL isinfo
,debug
,warning
, orcritical
. The default isinfo
.If running the gramps-web-api server locally, the following additional flags may be useful:
--use-wsgi
- adds a WSGI wrapper to the application.--host IP
- the IP address to use for the WSGI listener. The default IP is127.0.0.1
.--max-workers NUMBER
- for the WSGI server. Default is set dynamically based on the number of CPUs.--open-browser WHERE
- to open the browser on the default gramps-web-api page in atab
or awindow
. The default ofWHERE
isno
, meaning to not open a browser tab or window.