pywb/test_config.yaml

# pywb config file
# ========================================
#
# Settings for each collection

collections:
    # <name>: <cdx_path>
    # collection will be accessed via /<name>
    # <cdx_path> is a string or list of:
    #  - string or list of one or more local .cdx file
    #  - string or list of one or more local dirs with .cdx files
    #  - a string value indicating remote http cdx server
    pywb: ./sample_archive/cdx/

    # ex with filtering: filter CDX lines by filename starting with 'dupe'
    pywb-filt: {'index_paths': './sample_archive/cdx/', 'filters': ['filename:dupe*']}


# indicate if cdx files are sorted by SURT keys -- eg: com,example)/
# SURT keys are recommended for future indices, but non-SURT cdxs
# are also supported
#
#   * Set to true if cdxs start with surts: com,example)/
#   * Set to false if cdx start with urls: example.com)/
surt_ordered: true

# list of paths prefixes for pywb look to 'resolve'  WARC and ARC filenames
# in the cdx to their absolute path
#
# if path is:
#   * local dir, use path as prefix
#   * local file, lookup prefix in tab-delimited sorted index
#   * http:// path, use path as remote prefix
#   * redis:// path, use redis to lookup full path for w:<warc> as key

archive_paths: ./sample_archive/warcs/

# ==== Optional UI: HTML/Jinja2 Templates ====

# template for <head> insert into replayed html content
head_insert_html: ui/head_insert.html

# template to for 'calendar' query,
# eg, a listing of captures  in response to a ../*/<url>
#
# may be a simple listing or a more complex 'calendar' UI
# if omitted, will list raw cdx in plain text
query_html: ui/query.html

# template for search page, which is displayed when no search url is entered
# in a collection
search_html: ui/search.html

# template for home page.
# if no other route is set, this will be rendered at /, /index.htm and /index.html
home_html: ui/index.html


# error page temlpate for may formatting error message and details
# if omitted, a text response is returned
error_html: ui/error.html

# ==== Other Paths ====

# list of host names that pywb will be running from to detect
# 'fallthrough' requests based on referrer
#
# eg: an incorrect request for http://localhost:8080/image.gif with a referrer
# of http://localhost:8080/pywb/index.html, pywb can correctly redirect
# to http://localhost:8080/pywb/image.gif
#

#hostpaths: ['http://localhost:8080']

# Rewrite urls with absolute paths instead of relative
absoulte_paths: true

# List of route names:
# <route>: <package or file path>
static_routes:
          static/test/route: static/


# ==== New / Experimental Settings ====
# Not yet production ready -- used primarily for testing

# Enable simple http proxy mode
enable_http_proxy: true

# enable cdx server api for querying cdx directly (experimental)
enable_cdx_api: true
add new test_config.yaml! 2014-02-05 10:17:06 -08:00			`# pywb config file`
			`# ========================================`
			`#`
			`# Settings for each collection`

			`collections:`
			`# <name>: <cdx_path>`
			`# collection will be accessed via /<name>`
			`# <cdx_path> is a string or list of:`
			`# - string or list of one or more local .cdx file`
			`# - string or list of one or more local dirs with .cdx files`
			`# - a string value indicating remote http cdx server`
			`pywb: ./sample_archive/cdx/`

add optional filters to default Route add examples to config.yaml and test_config.yaml and integration test per route config is inherited globally if only name is set 2014-02-06 17:28:08 -08:00			`# ex with filtering: filter CDX lines by filename starting with 'dupe'`
			`pywb-filt: {'index_paths': './sample_archive/cdx/', 'filters': ['filename:dupe*']}`


add new test_config.yaml! 2014-02-05 10:17:06 -08:00			`# indicate if cdx files are sorted by SURT keys -- eg: com,example)/`
			`# SURT keys are recommended for future indices, but non-SURT cdxs`
			`# are also supported`
			`#`
			`# * Set to true if cdxs start with surts: com,example)/`
			`# * Set to false if cdx start with urls: example.com)/`
			`surt_ordered: true`

			`# list of paths prefixes for pywb look to 'resolve' WARC and ARC filenames`
			`# in the cdx to their absolute path`
			`#`
			`# if path is:`
			`# * local dir, use path as prefix`
			`# * local file, lookup prefix in tab-delimited sorted index`
			`# * http:// path, use path as remote prefix`
			`# * redis:// path, use redis to lookup full path for w:<warc> as key`

			`archive_paths: ./sample_archive/warcs/`

			`# ==== Optional UI: HTML/Jinja2 Templates ====`

			`# template for <head> insert into replayed html content`
add support for pywb static content routes (seperate from uwsgi) adding StaticHandler and loading templates and static resources from current package add default template and static data to be included in the pywb package add test for custom static route 2014-02-07 19:32:58 -08:00			`head_insert_html: ui/head_insert.html`
add new test_config.yaml! 2014-02-05 10:17:06 -08:00
			`# template to for 'calendar' query,`
			`# eg, a listing of captures in response to a ../*/<url>`
			`#`
			`# may be a simple listing or a more complex 'calendar' UI`
			`# if omitted, will list raw cdx in plain text`
add support for pywb static content routes (seperate from uwsgi) adding StaticHandler and loading templates and static resources from current package add default template and static data to be included in the pywb package add test for custom static route 2014-02-07 19:32:58 -08:00			`query_html: ui/query.html`
add new test_config.yaml! 2014-02-05 10:17:06 -08:00
			`# template for search page, which is displayed when no search url is entered`
			`# in a collection`
add support for pywb static content routes (seperate from uwsgi) adding StaticHandler and loading templates and static resources from current package add default template and static data to be included in the pywb package add test for custom static route 2014-02-07 19:32:58 -08:00			`search_html: ui/search.html`
add new test_config.yaml! 2014-02-05 10:17:06 -08:00
			`# template for home page.`
			`# if no other route is set, this will be rendered at /, /index.htm and /index.html`
add support for pywb static content routes (seperate from uwsgi) adding StaticHandler and loading templates and static resources from current package add default template and static data to be included in the pywb package add test for custom static route 2014-02-07 19:32:58 -08:00			`home_html: ui/index.html`
add new test_config.yaml! 2014-02-05 10:17:06 -08:00

			`# error page temlpate for may formatting error message and details`
			`# if omitted, a text response is returned`
add support for pywb static content routes (seperate from uwsgi) adding StaticHandler and loading templates and static resources from current package add default template and static data to be included in the pywb package add test for custom static route 2014-02-07 19:32:58 -08:00			`error_html: ui/error.html`
add new test_config.yaml! 2014-02-05 10:17:06 -08:00
			`# ==== Other Paths ====`

			`# list of host names that pywb will be running from to detect`
			`# 'fallthrough' requests based on referrer`
			`#`
			`# eg: an incorrect request for http://localhost:8080/image.gif with a referrer`
			`# of http://localhost:8080/pywb/index.html, pywb can correctly redirect`
			`# to http://localhost:8080/pywb/image.gif`
			`#`

paths cleanup: - don't store explicit static path, but allow it to be set in the insert - store host_prefix, which is either server name or empty - for archival mode, absolute_paths settings controls if using absolute paths, - for proxy always use absolute_paths - default static path is: /static/default/ - allow extension apps to provide custom /static/X/ path Route overriding: - ability to set Route class - custom init method Archival Relative Redirect: - if starting with timestamp, drop timestamp and assume host-relative path Integration Tests: - test proxy mode by using REQUEST_URI - test archival relative redirect! 2014-02-08 20:07:16 -08:00			`#hostpaths: ['http://localhost:8080']`

			`# Rewrite urls with absolute paths instead of relative`
			`absoulte_paths: true`
add support for pywb static content routes (seperate from uwsgi) adding StaticHandler and loading templates and static resources from current package add default template and static data to be included in the pywb package add test for custom static route 2014-02-07 19:32:58 -08:00
			`# List of route names:`
			`# <route>: <package or file path>`
			`static_routes:`
paths cleanup: - don't store explicit static path, but allow it to be set in the insert - store host_prefix, which is either server name or empty - for archival mode, absolute_paths settings controls if using absolute paths, - for proxy always use absolute_paths - default static path is: /static/default/ - allow extension apps to provide custom /static/X/ path Route overriding: - ability to set Route class - custom init method Archival Relative Redirect: - if starting with timestamp, drop timestamp and assume host-relative path Integration Tests: - test proxy mode by using REQUEST_URI - test archival relative redirect! 2014-02-08 20:07:16 -08:00			`static/test/route: static/`
add new test_config.yaml! 2014-02-05 10:17:06 -08:00

			`# ==== New / Experimental Settings ====`
			`# Not yet production ready -- used primarily for testing`

first pass at simple http proxy! #8 * proxy router for handling only proxy * proxy/archival router for handling both archival and proxy mode, togglable with 'enable_http_proxy' setting in config * supports only most recent capture playback -- no support for selecting replay date/calendar view yet * not testable with WebTest -- need better way to unit test proxy mode 2014-02-05 13:08:10 -08:00			`# Enable simple http proxy mode`
			`enable_http_proxy: true`

add new test_config.yaml! 2014-02-05 10:17:06 -08:00			`# enable cdx server api for querying cdx directly (experimental)`
			`enable_cdx_api: true`