nextcloud-memento/appinfo/ info.xml
56 lines
2.7 KiB

  1. <?xml version="1.0"?>
  2. <info xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd">
  4. <id>memento</id>
  5. <name>Memento</name>
  6. <summary>Turn your Nextcloud into a web archive</summary>
  7. <description>
  8. If you host snapshots of web pages on your Nextcloud, this app enables any client that speaks the
  9. Memento protocol to access these snapshots.
  10. The Memento protocol ([RFC7089][]) is widely used to ask archives (such as the Internet Archive's
  11. [Wayback Machine][]) for their copies of web pages. For example, a client (e.g. a browser extension)
  12. may ask an archive whether it has a copy of `https://nextcloud.com` from around July last year, and
  13. —if successful— will be redirected to the closest match.
  14. Currently this app only supports snapshots that are stored as plain html files. It recognises a file
  15. as being a snapshot if the file contains a &lt;link&gt; to the location of the original page; such
  16. snapshots can be created using [Freeze-dry][].
  17. This app requires the app [Raw][] to also be installed, in order to host the snapshots.
  18. ## Usage
  19. The app presents a Memento TimeGate at the `/timegate/{url}` route.
  20. For example, assume you have an html file `example.html` in the folder `Documents/snapshots`. If
  21. this file contains a `&lt;link rel="origin" href="https://example.org"&gt;` in its `&lt;head&gt;`,
  22. it will be recognised as a snapshot of `https://example.org`. Visiting
  23. `/apps/memento/timegate/https://example.org` would then redirect you to
  24. `/apps/raw/files/Documents/snapshots/example.html` (hence you need the [Raw] app as well).
  25. In a Memento client (e.g. the [Memento Time Travel][] browser extension), you add your personal
  26. archive as `https://my-nextcloud/apps/memento/timegate/` (of course first replace
  27. `my-nextcloud` appropriately).
  28. A TimeMap is also exposed, at the `/timemap/{url}` route, to list all available snapshots of a URL.
  29. For details, look at the documentation of the Memento protocol ([RFC7089][]).
  30. [Memento Time Travel]: https://addons.mozilla.org/en-US/firefox/addon/memento-timetravel/
  31. [RFC7089]: https://tools.ietf.org/html/rfc7089
  32. [Wayback Machine]: https://web.archive.org/
  33. [Freeze-dry]: https://github.com/WebMemex/freeze-dry
  34. [Raw]: https://code.treora.com/gerben/nextcloud-raw
  35. </description>
  36. <version>0.0.1</version>
  37. <licence>agpl</licence>
  38. <author mail="gerben@treora.com">Gerben</author>
  39. <namespace>Memento</namespace>
  40. <category>files</category>
  41. <repository type="git">https://code.treora.com/gerben/nextcloud-memento</repository>
  42. <bugs>https://code.treora.com/gerben/nextcloud-memento/issues</bugs>
  43. <dependencies>
  44. <nextcloud min-version="14" max-version="14"/>
  45. </dependencies>
  46. </info>