Permalink
Browse files

update CHANGES, config.yaml docs for proxy mode

ensure proxy_options match defaults in config.yaml
default cookie_resolver to true
  • Loading branch information...
1 parent 3a0b6fc commit 751084b0975aecc29409dc43ce2b1419ac132c79 @ikreymer committed Sep 7, 2014
Showing with 49 additions and 21 deletions.
  1. +5 −0 CHANGES.rst
  2. +3 −0 ca/README
  3. +34 −16 config.yaml
  4. +2 −2 pywb/framework/certauth.py
  5. +1 −1 pywb/framework/proxy.py
  6. +2 −2 pywb/ui/proxy_cert_download.html
  7. +2 −0 tests/test_config.yaml
View
@@ -5,6 +5,11 @@ pywb 0.6.0 changelist
* Revamped HTTP/S system: proxy collection and capture time switching via cookie!
+* removed *hostnames* setting in config.yaml. pywb no longer needs to know the host(s) it is running on, can infer the correct path from referrer
+on a fallback handling.
+
+* remove PAC config, just using direct proxy (HTTP and HTTPS) for simplicity.
+
pywb 0.5.4 changelist
~~~~~~~~~~~~~~~~~~~~~
View
@@ -0,0 +1,3 @@
+pywb Certificate Authority
+
+For proxy HTTPS support, the pywb-ca.pem root cert and per-host certificates will be created here
View
@@ -36,11 +36,41 @@ collections:
archive_paths: ./sample_archive/warcs/
-# The following are default settings -- uncomment to change
-# Set to '' to disable the ui
+# ==== Proxy Mode ====
+# Enable simple http proxy mode
+enable_http_proxy: true
+
+# Additional proxy options (defaults)
+# proxy_options:
+# enable HTTPS proxy support (requires openssl library)
+# enable_https_proxy: false
+#
+# use cookies to switch collections and capture times
+# if not enabled, requires use of proxy auth
+# cookie_resolver: true
+#
+# default collection to start out in proxy mode
+# if not set, will ask the first time
+# use_default_coll: pywb
+
+# use wildcard certificates when creating certs in proxy mode
+# helps lower number of certs created, by may not be compatible
+# with older libraries
+# use_wildcard_certs: true
+
+# if true, will not add any banner to proxy mode replay
+# unaltered_replay: false
+
+# Default settings for CA used by proxy mode
+# root_ca_file: ./ca/pywb-ca.pem
+# root_ca_name: pywb https proxy replay CA
+# certs_dir: ./ca/certs
# ==== UI: HTML/Jinja2 Templates ====
+# The following are default settings -- uncomment to change
+# Set to '' to disable the ui
+
# template for <head> insert into replayed html content
#head_insert_html: ui/head_insert.html
@@ -75,18 +105,6 @@ archive_paths: ./sample_archive/warcs/
static_routes:
static/default: pywb/static/
-# ==== New / Experimental Settings ====
-# Not yet production ready -- used primarily for testing
-
-# Enable simple http proxy mode
-enable_http_proxy: true
-
-# Additional proxy options (defaults)
-#proxy_options:
-# use_default_coll: true
-#
-# unaltered_replay: false
-
# enable cdx server api for querying cdx directly (experimental)
enable_cdx_api: true
@@ -100,5 +118,5 @@ enable_memento: true
# Replay content in an iframe
framed_replay: true
-debug_echo_env: True
-
+# debugging utility -- echo request data
+# debug_echo_env: false
@@ -16,11 +16,11 @@
# Duration of 100 years
CERT_DURATION = 100 * 365 * 24 * 60 * 60
-CERTS_DIR = './pywb-certs/'
+CERTS_DIR = './ca/certs/'
CERT_NAME = 'pywb https proxy replay CA'
-CERT_CA_FILE = './pywb-ca.pem'
+CERT_CA_FILE = './ca/pywb-ca.pem'
#=================================================================
@@ -79,7 +79,7 @@ def __init__(self, routes, **kwargs):
self.extra_headers = self.EXTRA_HEADERS
proxy_options['extra_headers'] = self.extra_headers
- if proxy_options.get('cookie_resolver'):
+ if proxy_options.get('cookie_resolver', True):
self.resolver = CookieResolver(routes, proxy_options)
else:
self.resolver = ProxyAuthResolver(routes, proxy_options)
@@ -2,13 +2,13 @@
{% if not available %}
<p>Sorry, HTTPS support is not configured for this proxy. However, the proxy should work in HTTP mode.</p>
{% else %}
-<p>Download for all platforms (except Windows):</p>
+<p>Download for all platforms except Windows (or Firefox on Windows):</p>
<p><b><a href="{{ pem_path }}">Download Certificate (All except Windows)</a></b></p>
<p>(If you see the <i>Already Installed</i> message, then no further action is necessary and you may start browsing!</p>
{% endif %}
-<p>Download for Windows platforms:</p>
+<p>Download for Windows platforms (except if using Firefox. For Firefox, use the above download, even on Windows):</p>
<p><b><a href="{{ p12_path }}">Download Certificate (Window Only)</a></b></p>
@@ -100,6 +100,8 @@ enable_http_proxy: true
proxy_options:
use_default_coll: true
+ cookie_resolver: false
+
unaltered_replay: false
# enable cdx server api for querying cdx directly (experimental)

0 comments on commit 751084b

Please sign in to comment.