Skip to content

Commit

Permalink
Docs: Update frameless replay banner info
Browse files Browse the repository at this point in the history
  • Loading branch information
tw4l committed Oct 17, 2022
1 parent 92d757e commit 4a5f448
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/manual/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,19 @@ With **framed replay**, the archived content is loaded into an iframe, and a top
In this mode, the top frame url is for example, ``http://my-archive.example.com/<coll name>/http://example.com/`` while
the actual content is served at ``http://my-archive.example.com/<coll name>/mp_/http://example.com/``

With **frameless replay**, the archived content is loaded directly. As of pywb 2.7, frameless replay is bannerless
unless a custom banner is added via the ``custom_banner.html`` template.


.. warning::
pywb 2.7 introduces a breaking change around frameless replay and banners.
Any custom banner intended to be used with frameless replay in pywb 2.7 and
higher must be specified in the ``custom_banner.html`` template. This may
require moving custom content from ``banner.html`` to the new
``custom_banner.html``.

The default banner will no longer be served in frameless replay.

With **frameless replay**, the archived content is loaded directly, and a banner UI is injected into the page.

In this mode, the content is served directly at ``http://my-archive.example.com/<coll name>/http://example.com/``

Expand Down

0 comments on commit 4a5f448

Please sign in to comment.