mirror of
https://github.com/webrecorder/pywb.git
synced 2025-03-15 00:03:28 +01:00
update README, fix typo
This commit is contained in:
parent
9cde058ccf
commit
937fc7229e
19
README.md
19
README.md
@ -103,31 +103,36 @@ hostpaths: ['http://localhost:8080/']
|
||||
(Refer to [full version of config.yaml](config.yaml) for additional documentation)
|
||||
|
||||
|
||||
The init path can be customized further:
|
||||
|
||||
|
||||
* The `PYWB_CONFIG` env can be used to set a different file.
|
||||
* The `PYWB_CONFIG` env can be used to set a different yaml file.
|
||||
|
||||
* The `PYWB_CONFIG_MODULE` env variable can be used to set a different init module, for implementing a custom init
|
||||
|
||||
(or for extensions not yet supported via yaml)
|
||||
|
||||
* The `PYWB_CONFIG_MODULE` env variable can be used to set a different init module
|
||||
|
||||
See `run.sh` for more details
|
||||
|
||||
|
||||
### Running with Existing CDX/WARCs
|
||||
|
||||
If you have existing warc and cdx files, you can adjust the `index_paths` and `archive_paths` to point to
|
||||
If you have existing .warc/.arc and .cdx files, you can adjust the `index_paths` and `archive_paths` to point to
|
||||
the location of those files.
|
||||
|
||||
#### SURT
|
||||
|
||||
By default, pywb expects the cdx files to be Sort-Friendly-Url-Transform (SURT) ordering. This is an ordering
|
||||
that transforms: `example.com` -> `com,example)/` to faciliate better search. It is recommended for future indexing.
|
||||
By default, pywb expects the cdx files to be Sort-Friendly-Url-Transform (SURT) ordering.
|
||||
This is an ordering that transforms: `example.com` -> `com,example)/` to faciliate better search.
|
||||
It is recommended for future indexing, but is not required.
|
||||
|
||||
However, non-SURT ordered cdx indexs will work as well, but be sure to specify
|
||||
Non-SURT ordered cdx indexs will work as well, but be sure to specify:
|
||||
|
||||
`surt_ordered: False` in the [config.yaml](config.yaml)
|
||||
|
||||
|
||||
### Generating new CDX
|
||||
### Creating CDX from WARCs
|
||||
|
||||
TODO
|
||||
|
||||
|
@ -14,7 +14,7 @@ class PrefixResolver:
|
||||
self.contains = contains
|
||||
|
||||
def __call__(self, filename):
|
||||
return [self.prefix + filename] if (self.contains in url) else []
|
||||
return [self.prefix + filename] if (self.contains in filename) else []
|
||||
|
||||
#======================================
|
||||
class RedisResolver:
|
||||
|
Loading…
x
Reference in New Issue
Block a user