diff --git a/docs/manual/configuring.rst b/docs/manual/configuring.rst index 4954ae2b..7f96194c 100644 --- a/docs/manual/configuring.rst +++ b/docs/manual/configuring.rst @@ -102,6 +102,96 @@ When resolving a ``example.warc.gz``, pywb will then check (in order): * Then, ``http://remote-backup.example.com/collections//example.warc.gz`` (if first lookup unsuccessful) +UI Customizations +----------------- + +pywb supports UI customizations, either for an entire archive, +or per-collection. + +Static Files +^^^^^^^^^^^^ + +The replay server will automatically support static files placed under the following directories: + +* Files under the root ``static`` directory can be accessed via ``http://my-archive.example.com/static/`` + +* Files under the per-collection ``./collections//static`` directory can be accessed via ``http://my-archive.example.com/static/_//`` + +Templates +^^^^^^^^^ + +pywb users Jinja2 templates to render HTML to render the HTML for all aspects of the application. +A version placed in the ``templates`` directory, either in the root or per collection, will override that template. + +To copy the default pywb template to the template directory run: + +``wb-manager template --add search_html`` + +The following templates are available: + + * ``home.html`` -- Home Page Template, used for ``http://my-archive.example.com/`` + + * ``search.html`` -- Collection Template, used for each collection page ``http://my-archive.example.com//`` + + * ``query.html`` -- Capture Query Page for a given url, used for ``http://my-archive.example.com/`` + +Error Pages: + + * ``not_found.html`` -- Page to show when a url is not found in the archive + + * ``error.html`` -- Generic Error Page for any error (except not found) + +Replay and Banner templates: + + * ``frame_insert.html`` -- Top-frame for framed replay mode (not used with frameless mode) + + * ``head_insert.html`` -- Rewriting code injected into ```` of each replayed page. + This template includes the banner template and itself should generally not need to be modified. + + * ``banner.html`` -- The banner used for frameless replay. Can be set to blank to disable the banner. + + +Custom Outer Replay Frame +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The top-frame used for framed replay can be replaced or augmented +by modifiying the ``frame_insert.html``. + +To start with modifiying the default outer page, you can add it to the current +templates directory by running ``wb-frame template --add frame_insert.html`` + +To initialize the replay, the outer page should include ``wb_frame.js``, +create an ``