From 3f66db754ca23cd3d41a755a07992f11b6276f5d Mon Sep 17 00:00:00 2001 From: Benji Hooper Date: Thu, 23 Aug 2018 18:42:41 +0100 Subject: [PATCH] Update documentation to reference PAC files --- docs/pages/reference/api/api.rst | 26 +++++++++++++++++++ .../advanced/behindaproxy/behindaproxy.rst | 11 ++++++++ 2 files changed, 37 insertions(+) diff --git a/docs/pages/reference/api/api.rst b/docs/pages/reference/api/api.rst index 6f83063b8..8eb570521 100644 --- a/docs/pages/reference/api/api.rst +++ b/docs/pages/reference/api/api.rst @@ -366,6 +366,32 @@ Gets the upstream proxy configured for Hoverfly. ------------------------------------------------------------------------------------------------------------- +GET /api/v2/hoverfly/pac +"""""""""""""""""""""""" + +Gets the PAC file configured for Hoverfly. + + +------------------------------------------------------------------------------------------------------------- + + +PUT /api/v2/hoverfly/pac +"""""""""""""""""""""""" + +Sets the PAC file for Hoverfly. + + +------------------------------------------------------------------------------------------------------------- + + +DELETE /api/v2/hoverfly/pac +"""""""""""""""""""""""" + +Unsets the PAC file configured for Hoverfly. + +------------------------------------------------------------------------------------------------------------- + + GET /api/v2/cache """""""""""""""""""" Gets the requests and responses stored in the cache. diff --git a/docs/pages/tutorials/advanced/behindaproxy/behindaproxy.rst b/docs/pages/tutorials/advanced/behindaproxy/behindaproxy.rst index 99acfd558..513f5d755 100644 --- a/docs/pages/tutorials/advanced/behindaproxy/behindaproxy.rst +++ b/docs/pages/tutorials/advanced/behindaproxy/behindaproxy.rst @@ -16,6 +16,17 @@ For example, if the 'upstream' proxy is running on port ``8080`` on host ``corp. hoverctl start --upstream-proxy http://corp.proxy:8080 +Configuring Hoverfly with a PAC file +------------------------------------ + +If you have a PAC file for configuring clients with the proxy set up in your environment, you can use this to configure Hoverfly. + +For example: + +.. code:: bash + + hoverctl start --pac-file path/to/file.pac + Upstream proxy authentication -----------------------------