ukwa/ukwa-pywb

UKWA PYWB访问系统

本仓库是https://github.com/webrecorder/pywb%E7%9A%84%E5%AE%9A%E5%88%B6%E6%89%A9%E5%B1%95%EF%BC%8C%E4%B8%93%E4%B8%BA%E8%8B%B1%E5%9B%BD%E7%BD%91%E7%BB%9C%E6%A1%A3%E6%A1%88%E9%A6%86(UKWA)%E8%AE%BE%E8%AE%A1%E3%80%82%E5%AE%83%E5%8C%85%E5%90%AB%E4%BB%A5%E4%B8%8B%E5%AE%9A%E5%88%B6%E5%8A%9F%E8%83%BD%EF%BC%9A

• UKWA自定义UI
  • 文本选择限制
  • 嵌入内容支持
• 单并发锁系统
• 选择词限制(SELECT_WORD_LIMIT)
• 视频支持/优化（待确认）
• 内容类型重定向（待确认）
• 下载限制（待确认）
• Memento Prefer Header初步实现（详见https://github.com/mementoweb/rfc-extensions/issues/7%EF%BC%8C%E5%BE%85%E7%A1%AE%E8%AE%A4%EF%BC%9A%E7%8E%B0%E5%B7%B2%E9%9B%86%E6%88%90%E5%88%B0PyWB%EF%BC%89
• ePub/PDF阅读器支持（待添加）
• NPLD查看器访问控制设置

以及标准PyWB功能的配置文件：

• 本地化
• 访问控制
• HTTP/S代理模式
• NPLD查看器访问控制设置
• Memento Prefer Header初步实现（详见https://github.com/mementoweb/rfc-extensions/issues/7%EF%BC%89

本仓库构建ukwa-pywb容器镜像，基于官方pywb容器镜像扩展。过去，额外的PyWB功能在https://github.com/ukwa/pywb%E5%BC%80%E5%8F%91%EF%BC%8C%E7%8E%B0%E5%B7%B2%E5%85%A8%E9%83%A8%E5%90%88%E5%B9%B6%E5%88%B0%E4%B8%8A%E6%B8%B8%EF%BC%8C%E5%9B%A0%E6%AD%A4%E5%8F%AF%E7%9B%B4%E6%8E%A5%E4%BE%9D%E8%B5%96PyWB%E5%AE%98%E6%96%B9%E7%89%88%E6%9C%AC%E3%80%82

升级PyWB

通过修改https://github.com/ukwa/ukwa-pywb/blob/master/Dockerfile#L2-L3%E5%8D%B3%E5%8F%AF%E5%8D%87%E7%BA%A7%E6%9C%AC%E9%A1%B9%E7%9B%AE%E3%80%82%E9%80%9A%E5%B8%B8%E5%8D%87%E7%BA%A7%E8%BF%87%E7%A8%8B%E5%B9%B3%E6%BB%91%EF%BC%8C%E4%BD%86%E6%9C%89%E6%97%B6PyWB%E7%9A%84%E5%8F%98%E6%9B%B4%E4%BC%9A%E5%BD%B1%E5%93%8D%E5%AE%9A%E5%88%B6%E5%8A%9F%E8%83%BD%EF%BC%88%E5%A6%82%E6%A8%AA%E5%B9%85%E6%A8%A1%E6%9D%BF%E5%A4%84%E7%90%86%EF%BC%89%EF%BC%8C%E9%9C%80%E9%80%9A%E8%BF%87%E9%9B%86%E6%88%90%E6%B5%8B%E8%AF%95%E9%AA%8C%E8%AF%81%E3%80%82

测试通过后，版本号应以PyWB版本为基础命名，例如基于webrecorder/pywb:2.6.2的ukwa/ukwa-pywb版本应为2.6.2。若需在相同PyWB版本下修复问题，可添加点后缀，如2.6.2.1、2.6.2.2等。

构建完成后，需在相关https://github.com/ukwa/ukwa-services%E4%B8%AD%E9%83%A8%E7%BD%B2%EF%BC%8C%E5%8C%85%E6%8B%AC%E7%BD%91%E7%AB%99%E3%80%81w3act%E5%92%8C%E9%98%85%E8%A7%88%E5%AE%A4%E6%9C%8D%E5%8A%A1%E6%A0%88%E3%80%82

开发设置

本地构建运行

1. 克隆仓库后，使用Python 3.7+创建虚拟环境
2. 安装依赖：

   bash
   python setup.py install
   

3. 启动服务：

   bash
   uwsgi uwsgi.ini
   

   服务将使用uwsgi.ini配置，默认在8080端口运行，使用./integration-test/test-data/中的CDX和WARC文件。若端口冲突，可复制uwsgi.ini修改端口后使用。

集成测试

如需测试Redis等额外服务，使用集成测试环境：

1. 进入集成测试目录：

   bash
   cd integration-test/
   

2. 本地构建容器：

   bash
   docker-compose build pywb
   

3. 首次运行需初始化测试数据：

   bash
   docker-compose up populate pywb
   

4. 后续仅需重建测试pywb：

   bash
   docker-compose up pywb
   

本地运行时，服务可通过http://localhost:8081访问，包含：

• 归档酸性测试示例：http://localhost:8081/open-access/*/http://acid.matkelly.com/
• HTTP 451资源示例：http://localhost:8081/open-access/20180203004147/http://[***]

详见集成测试。

部署与配置

本项目可本地部署或通过Docker部署：

• 部署详情：参见部署文档
• 配置说明：参见配置文档（含config.yaml文件及选项说明）
• 测试套件：参见集成测试