Commit Graph
25 Commits
Author SHA1 Message Date
Ilya Kreymer 0bb4f15eb3 docs: update embedding guide with new replay-with-info embed mode
README: mention that replayweb.page can be run as static web server
2022-11-04 13:43:51 -07:00
Ilya Kreymer 43122425e5 Restrict new windows in replay + improved service worker loading + better error messages (#126)
* embeds:
- support target rewriting with named iframe as per webrecorder/wombat#94
- refactor sw init: detect additional errors, such as CORS issues in nested iframes
- support cross-origin replaybase for embeds
- add 'requirecrossoriginiframe' to restrict embed to only be loaded in subdomain iframes, otherwise showing
- rename noSandbox -> sandbox, not enabled by default

init: set appName on service worker init
docs:
- add example embed to embedding doc
- update docs for noSandbox -> sandbox
- add warning if deprecated 'noSandbox' flag is used, explaining that it is now deprecated
- update embedding and CHANGES.md with latest features
- add tweet-example.wacz
- add embed.html to test embeds

bump to 1.7.0-beta.1
2022-10-03 20:04:35 -07:00
Ilya Kreymer 27a8524aac Archive verification info + Embed improvements + Embed Receipts UI (#125)
info panel verification/integrity additions, (fixes on #113)
- info panel: display number of hashes verified valid (and invalid), observer domain (if any), and certificate fingerprint, creation software, and package digest
- info: ensure replayTS is updated, not just replayUrl, to ensure correct stats

404 page: improved formatting on 404 page (via wabac.js)

embeds:
- new embed 'replay-with-info mode, displays replay-only with dropdown showing archival 'receipt, which includes condensed info and verification (hashes valid/invalid, observer domain, cert fingerprint)
- support 'newWindowBase' attribute for specifying base replay URL for opening new window. default: use current url if deepLink enabled, otherwise use https://replayweb.page/
use transparent for embeds
- embed dropdown/receipt styling from @Shrinks99 
- automatically setting noCache and noWebWorker for older browsers (eg. safari < 16)
- add 'hideOffscreen' attribute to enable unloading embed when offscreen

dependencies: update to wabac.js 2.13.0-beta.0

bump version to 1.7.0-beta.0

Embed receipt styling co-authored-by: @Shrinks99
2022-10-01 18:22:30 -07:00
Ed Summers 4cb52b4480 Fix WACZ example (#121)
Fix the https://webrecorder-builds.s3.amazonaws.com/wacz/netpreserve-twitter.wacz dead link to point at https://replayweb.page/docs/assets/example.wacz instead.
2022-09-19 10:52:15 -07:00
Ed Summers 0101b45f7d Self-hosted embedding (#115)
* Self-hosted embedding

Add a self-hosted section to the embedding guide which references
webrecorder/example-webarchive and webrecorder/web-replay-gen.
The introductory paragraph was tightened up a little bit in places. The
examples now use WACZ instead of WARC, but intro also mentions that
the replay-web-page component supports WARC.

* add sentence about default replayBase

Closes #114
2022-08-31 23:14:42 -07:00
Ilya Kreymer 6c6d66f03a loading: add 'noCache' option for <replay-web-page> embeds, ensure option is passed to wabac.js loader
dependencies: update to wabac.js 2.12.3 to fully support noCache for WARCs
bump to 1.6.4
2022-08-06 17:56:16 -07:00
Ilya Kreymer 36da7fa2c6 Add a 'noWebWorker=true' option to <replay-web-page> embed to disable loading in separate web worker (#102)
* add a 'noWebWorker' option to <replay-web-page> embed to disable the default webworker-based loading, and load via the service worker directly. this feature was previously available, but turned-off, as its less efficient (uses sw for what can be done in a separate web worker thread). however, service-worker based loading may be needed for certain edge cases (see #97), and this option enables this loading method to be turned back on for embedding.
* docs: update guide to include 'noWebWorker', also use include attribute for boolean attributes
* update CHANGES.md
* bump to 1.5.12
2022-06-15 11:38:04 -07:00
Ilya Kreymer 6bba41e574 docs: update info on configuring cors 2022-03-02 11:09:23 -08:00
Jenny Ryan 7eab45554e minor copyedits (#85) 2022-02-01 10:28:20 -08:00
Ilya Kreymer 0ef8f955db 1.4.0 Release (#45)
* customizations for chooser, coll-index and appmain to support usage in archiveweb.page
- chooser: support panel/message view
- move apiPrefix to misc
- make coll-index extensible, overridable styles, filtering

* api changes: make configurable in coll-index, now using '/w/' instead of '/wabac/', '/c/' prefix for coll apis

* lint pass!

* bulma: update to 0.9.2, fix delete spinner with latest bulma

* ui fixes:
- show 'Loading Archives...' on initial load until first api response succeeds
- fix typo in oncontrollerchange not actually resolving the promise!

* embed sandbox: add other allow options, except top-nav
- first api load: keep loading message until first successful api load
- don't reset hash on purge to keep current page
- sw config: fix typo with latest wabac.js
- embed: add 'noSandbox' option to avoid adding sandbox to iframe, needed to show PDFs, add more allow rules (all except top-navigation)

* ui improvements:
- refresh: ensure location refresh from hitting enter in location bar always resets url
- pageentry doubleclick: ensure double-clicking on page in sidebar always triggers reload, even if current page
- pageentry typo fix: fix missing var causing selection error (fixes webrecorder/archivewebpage#25)
- lint: don't include 'event' as global
- use latest wabac.js 2.7.0-beta.1

* add CHANGES for 1.4.0, add 'noSandbox' to embedding options
- electron app: fix path to 'w/'
- bump electron to 11.4.3

* docs: autoload current version from package.json
- chooser: support .json files for multiwacz (experimental)
- update CHANGES.md
- add missing .eslintrc.js file

* bump version to 1.4.0
2021-04-25 16:45:40 -07:00
David Germain 36ae1aefda docs: fix path to static source (#44) 2021-04-24 16:09:46 -07:00
Ed Summers 3f3ed4d3a0 docs: fix small typo that was creating a 404 (#41) 2021-04-06 10:19:26 -07:00
Ilya Kreymer 7b41fdc234 embedding tweaks: resolve relative "source" URL to current page before passing to app
docs: embedding: add example using latest npm release for testing, recommend versioned releases for production
2021-03-18 22:17:41 -07:00
Ilya Kreymer 1968a5862b docs: minor tweaks to embedding guide 2021-03-18 21:54:08 -07:00
Ilya Kreymer d86ab8300b loading fixes: fix pages loaded from wacz files having the wrong timestamp, more efficent loading of wacz files even if HEAD method is not supported (from wabac.js 2.6.6)
docs: embedding: add that relative paths are relative to replayBase
bump to 3.1.12
2021-03-18 21:05:18 -07:00
Ilya KreymerandDaleLore f35776e165 Docs Improvements (#39)
* Restructure - wrote and added photos for online and offline use

* add new images

* add more info on embedding options, add CORS configuration example

Co-authored-by: DaleLore <DaleLore@protonmail.com>
2021-03-17 20:34:19 -07:00
Ilya Kreymer 6208baf7c7 dependencies: update to wabac.js 2.6.0, more fidelity improvements related to POST request indexing 2021-02-26 19:25:57 -08:00
Ilya Kreymer 5553d7f550 dev testing: add embed-test.html for subdomain embed test 2021-02-24 18:11:53 -08:00
Ilya Kreymer 8b6c06d46e docs tweak: add examples page, link to examples from home page
update to latest sw, ensure OPTIONS is not indexed as mentioned in webrecorder/pywb#569
ensure plugins-* directories are excluded from git and from jekyll
bump version to 1.0.1-alpha.0
2020-06-16 16:29:52 -07:00
Aaron a39e16b309 Fix a few typos in the documentation (#2)
Signed-off-by: Aaron <admin@datahoarder.dev>
2020-06-12 07:00:11 -07:00
Ilya Kreymer ae872cd219 docs and README: add wacz format doc, tweak links, tweak README 2020-06-11 15:08:24 -07:00
Ilya Kreymer b9a4089c6b license / docs pass:
- add new docs for loading, exploring, sharing, embedding, and offline usage
- add license file / license banner

electron app:
- for now, don't bundle docs, open in native browser

embeds:
- support 'embed' option, 'replayonly' or 'full' (default if no url)

ui:
- display package.json version in info menu

package.json:
- update scripts to match README
- move electron entrypoint into extraMetadata
- add scripts for packaging as module

README: minor edits
2020-06-11 00:42:10 -07:00
Ilya Kreymer 220d14aea3 jekyll: move jekyll back to root, but simpler setup, exclude via _config.yml
app: bundle jekyll docs into app, add 'yarn run docs' to build
ui: add back/forward arrows for app only, adjust responsiveness for app, add IS_APP flag injected via preload
ui: add animated logo, friendly message on empty replay frame
app: improve serve logic:
- serve static files from static root
- serve replay from http localhost instead to avoid proxying https for remote requests
- serve local lookup from http prefix also
- catch any fallthrough from replay as 404
- add timestamp to response channels to ensure uniqness
2020-05-21 18:49:26 -07:00
Ilya Kreymer da1e5c03df reorg dir structure:
- keep shared and electron build at root
- move static files for replayweb.page and Jekyll config to docs/
- move Jekyll markdown to docs/docs/
2020-05-20 17:28:03 -07:00
Ilya Kreymer ed456fbb5f docs: add jekyll just-the-docs docs, initial pass 2020-05-03 22:21:07 -07:00