Skip to content

Commit e0b4406

Browse files
committed
Add docs for wb-manager add --uncompress-wacz
1 parent 1e2665a commit e0b4406

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/manual/apps.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ The tool can be used while ``wayback`` is running, and pywb will detect many cha
4545
It can be used to:
4646

4747
* Create a new collection -- ``wb-manager init <coll>``
48-
* Add WARCs or WACZs to collection -- ``wb-manager add <coll> <warc/wacz>``
48+
* Add WARCs to collection -- ``wb-manager add <coll> <warc>``
49+
* Unpack WACZs to add their WARCs and indices to collection -- ``wb-manager add --uncompress-wacz <coll> <wacz>``
4950
* Add override templates
5051
* Add and remove metadata to a collections ``metadata.yaml``
5152
* List all collections

docs/manual/usage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ Using Existing Web Archive Collections
114114
Existing archives of WARCs/ARCs files can be used with pywb with minimal amount of setup. By using ``wb-manager add``,
115115
WARC/ARC files will automatically be placed in the collection archive directory and indexed.
116116

117+
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.
118+
117119
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.
118120

119121
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.

0 commit comments

Comments
 (0)