From e7966b88cdf701f01fa4d2b3ab7b94f592c220d2 Mon Sep 17 00:00:00 2001 From: Ilya Kreymer Date: Sat, 3 Mar 2018 17:15:03 -0800 Subject: [PATCH] Update README as index into docs #15 --- README.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 755851a..322bbcc 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,23 @@ -UKWA PYWB Deployment -==================== +UKWA PYWB Access System +======================= -This repo represents a customized deployment of [pywb](https://github.com/webrecorder/pywb) for the UK Web Archive. +This repository represents a customized extension of [pywb](https://github.com/webrecorder/pywb) for use with the UK Web Archive. It includes: -Running with Integration Tests ------------------------------- +- Custom UI for UKWA +- [Single-Concurrent Lock System](docs/locks.md) +- [Localization](docs/localization.md) +- [Access Controls](docs/access_controls.md) -See [integration-test](integration-test) for more info on running the full test suite in Docker. +This repository ships a custom package `ukwa_pywb`, which extends the `pywb`. -After starting the test suite, the UKWA pywb server will be running at `http://localhost:8081/` +Currently, it is to be used with the [ukwa/pywb fork of pywb](https://github.com/ukwa/pywb) until this fork is merged into a future pywb release. +## Deployment and Configuration -Running Locally ---------------- +The project can be deployed locally or in Docker. -The deployment can also be run locally using sample data from [integration-test/test-data](integration-test/test-data) +- See [Deployment](docs/deployment.md) for more information about deploying this repository and running tests. -1) Install the [UKWA fork of pywb](https://github.com/ukwa/pywb) and run `python setup.py install` in a Python 3 environment. +- See [Configuration](docs/configuration.md) for more information about the `config.yaml` file and its options. -2) Run `run-ukwa-pywb.sh`. This will start the server on default port (8080). - - (To choose a different port, run `run-ukwa-pywb.sh -p 8060` - - The script accepts all the params of default `wayback` or `pywb` commands) - +- See [Integration Tests](integration-test/README.md) on how to run the included integration test suite.