github.com/pypiserver
1
0
Fork 1
mirror of https://github.com/pypiserver/pypiserver synced 2024-11-09 16:45:51 +01:00
Code Releases Wiki Activity

Health endpoint usage is missing. (#481)

Browse Source 
Health endpoint 

README’s `pypi-server run` arguments document is remove by PR #451, and health-endpoint is missing when the `pypi-server run` arguments document bring back in #478
This commit is contained in:
Mason Lin 2023-04-27 20:41:58 +08:00 committed by GitHub
parent e0c9723ee7
commit 73dbe153e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -132,8 +132,8 @@ message *about starting the server*::
usage: pypi-server run [-h] [-v] [--log-file FILE] [--log-stream STREAM] [--log-frmt FORMAT] [--hash-algo HASH_ALGO] usage: pypi-server run [-h] [-v] [--log-file FILE] [--log-stream STREAM] [--log-frmt FORMAT] [--hash-algo HASH_ALGO]
[--backend {auto,simple-dir,cached-dir}] [--version] [-p PORT] [-i HOST] [-a AUTHENTICATE] [-P PASSWORD_FILE] [--disable-fallback] [--backend {auto,simple-dir,cached-dir}] [--version] [-p PORT] [-i HOST] [-a AUTHENTICATE] [-P PASSWORD_FILE] [--disable-fallback]
[--fallback-url FALLBACK_URL] [--server METHOD] [-o] [--welcome HTML_FILE] [--cache-control AGE] [--log-req-frmt FORMAT] [--fallback-url FALLBACK_URL] [--health-endpoint HEALTH_ENDPOINT] [--server METHOD] [-o] [--welcome HTML_FILE]
[--log-res-frmt FORMAT] [--log-err-frmt FORMAT] [--cache-control AGE] [--log-req-frmt FORMAT] [--log-res-frmt FORMAT] [--log-err-frmt FORMAT]
[package_directory [package_directory ...]] [package_directory [package_directory ...]]
positional arguments: positional arguments:
@ -180,6 +180,10 @@ message *about starting the server*::
--disable-fallback Disable the default redirect to PyPI for packages not found in the local index. --disable-fallback Disable the default redirect to PyPI for packages not found in the local index.
--fallback-url FALLBACK_URL --fallback-url FALLBACK_URL
Redirect to FALLBACK_URL for packages not found in the local index. Redirect to FALLBACK_URL for packages not found in the local index.
--health-endpoint HEALTH_ENDPOINT
Configure a custom liveness endpoint.
It always returns 200 Ok if the service is up.
Otherwise, it means that the service is not responsive.
--server METHOD Use METHOD to run the server. Valid values include paste, cherrypy, twisted, gunicorn, gevent, wsgiref, and auto. The default is to --server METHOD Use METHOD to run the server. Valid values include paste, cherrypy, twisted, gunicorn, gevent, wsgiref, and auto. The default is to
use "auto", which chooses one of paste, cherrypy, twisted, or wsgiref. use "auto", which chooses one of paste, cherrypy, twisted, or wsgiref.
-o, --overwrite Allow overwriting existing package files during upload. -o, --overwrite Allow overwriting existing package files during upload.