Skip to content

Commit

Permalink
Add docs for wb-manager add --uncompress-wacz
Browse files Browse the repository at this point in the history
  • Loading branch information
tw4l committed Apr 23, 2024
1 parent b4c91c6 commit 4a645ee
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/manual/apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ The tool can be used while ``wayback`` is running, and pywb will detect many cha
It can be used to:

* Create a new collection -- ``wb-manager init <coll>``
* Add WARCs or WACZs to collection -- ``wb-manager add <coll> <warc/wacz>``
* Add WARCs to collection -- ``wb-manager add <coll> <warc>``
* Unpack WACZs to add their WARCs and indices to collection -- ``wb-manager add --uncompress-wacz <coll> <wacz>``
* Add override templates
* Add and remove metadata to a collections ``metadata.yaml``
* List all collections
Expand Down
2 changes: 2 additions & 0 deletions docs/manual/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ Using Existing Web Archive Collections
Existing archives of WARCs/ARCs files can be used with pywb with minimal amount of setup. By using ``wb-manager add``,
WARC/ARC files will automatically be placed in the collection archive directory and indexed.

In pywb 2.8.0 and later, preliminary support for WACZ files is also added with ``wb-manager add --uncompress-wacz``. This will unpack the provided WACZ file, adding its WARCs and indices to the collection.

By default ``wb-manager``, places new collections in ``collections/<coll name>`` subdirectory in the current working directory. To specify a different root directory, the ``wb-manager -d <dir>``. Other options can be set in the config file.

If you have a large number of existing CDX index files, pywb will be able to read them as well after running through a simple conversion process.
Expand Down

0 comments on commit 4a645ee

Please sign in to comment.