.. _configuring-pywb-ui: 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. For those looking to customize the default template(s) when deploying pywb, the following templates located in the pywb/templates directory. * ``base.html`` -- The base template used for non-replay related pages. * ``head.html`` -- Template containing content to be added to the ```` of the ``base`` template * ``header.html`` -- Template to be added as the first content of the ```` tag of the ``base`` template * ``footer.html`` -- Template for adding content as the "footer" of the ```` tag of the ``base`` template The ``base.html`` template also provides five blocks that can be supplied by templates that extend it. * ``title`` -- Block for supplying the title for the page * ``head`` -- Block for adding content to the ````, includes ``head.html`` template * ``header`` -- Block for adding content to the ```` before the ``body`` block, includes the ``header.html`` template * ``body`` -- Block for adding the primary content to template * ``footer`` -- Block for adding content to the ```` after the ``body`` block, includes the ``footer.html`` template Custom Outer Replay Frame ^^^^^^^^^^^^^^^^^^^^^^^^^ The top-frame used for framed replay can be replaced or augmented by modifying the ``frame_insert.html``. To start with modifying the default outer page, you can add it to the current templates directory by running ``wb-manager template --add frame_insert_html`` To initialize the replay, the outer page should include ``wb_frame.js``, create an ``