ukwa/w3act

w3act

镜像概述和主要用途

w3act是一款用于网络档案的注释和管理工具，旨在帮助用户对网络资源进行注释、整理和管理，支持网络档案的元数据处理与保存，适用于数字档案管理、网络资源归档等场景。

核心功能和特性

• 网络档案注释：支持对网络资源添加注释信息
• 资源管理：提供网络资源的整理与管理功能
• 多数据库支持：兼容H2和PostgreSQL数据库
• 集成工具链：可与Play Framework、Java、Maven等工具集成
• 开发与生产模式：支持开发环境调试和生产环境部署
• API支持：提供API接口，便于外部系统集成

使用场景和适用范围

• 网络档案管理机构：用于网络资源的归档与注释
• 数字保存项目：对网络内容进行整理和元数据管理
• 研究机构：管理和注释研究所需的网络资源
• 开发团队：开发网络档案相关应用的测试与调试

详细的使用方法和配置说明

安装要求

安装w3act需满足以下依赖：

• W3ACT源代码
• Play Framework
• PostgreSQL数据库
• Java（如JDK 6）
• Maxmind GeoIP2数据库
• Whois gem
• Maven

下载信息

安装步骤

请参考相关工具的安装说明。以下是Whois功能的安装步骤：

1. 从download-whois下载JRuby JARs
2. 解压ZIP文件，在jruby-1.7.9文件夹中执行：

   bash
   gem install whois
   

3. 将JRuby JARs（jruby.jar和jruby-complete-1.7.9.jar）复制到项目的"lib"文件夹
4. 下载https://github.com/ukwa/jruby-whois/blob/master/src/main/java/uk/bl/wa/whois/JRubyWhois.java Maven项目，执行编译：

   bash
   mvn clean install
   

5. 创建JAR包：

   bash
   mvn package
   

6. 将生成的jruby-whois-3.4.2.2-SNAPSHOT.jar复制到项目的"lib"文件夹

生产模式使用

配置详情

生产环境配置文件prod.conf需包含PostgreSQL数据库配置，或从application.conf导入。

• H2数据库配置：

  db.default.driver=org.h2.Driver
  db.default.url="jdbc:h2:mem:play;DB_CLOSE_DELAY=-1"
  

• PostgreSQL数据库配置：

  db.default.driver=org.postgresql.Driver
  # 创建用户为'training'的数据库'w3actprod'
  db.default.url="postgres://training:(password)@127.0.0.1/w3actprod"
  

• Travis CI配置：

  1. 创建配置文件conf/travis-ci.conf，使用H2数据库覆盖默认PostgreSQL配置
  2. 编辑.travis.yml，修改脚本行：

     yaml
     script: play-${PLAY_VERSION}/play -Dconfig.file=conf/travis-ci.conf test
     

执行命令

打开终端执行：

bash
play clean stage

该命令会生成Windows的BAT文件或Linux的SH文件，用于启动应用。

注意：使用"play start"可能导致关闭应用时PID未正确终止，且会在项目根目录创建RUNNING_PID文件，需手动删除。Windows环境可使用"tasklist"查看进程，"taskkill /pid [PID] /F"终止进程。

Linux执行步骤

[RHEL安装] wiki提供了带注释的Linux部署命令。

开发模式使用

1. 打开DOS窗口执行：

   bash
   play run
   

2. 启动浏览器，访问URL：

   localhost:9000/actdev/
   

测试

执行以下命令进行测试：

bash
play test

文档

• 领域对象模型和用户流程描述可在https://github.com/ukwa/w3act/wiki中找到
• 初始权限和角色定义在initial-data.yml中

开发要求

构建需以下工具：

• Git客户端
• Java Developers Kit（如JDK 6）
• Play Framework
• PostgreSQL数据库

推荐IDE及插件：

• Eclipse Kepler Service Release 1 with m2eclipse插件 http://eclipse.org/eclipse

设置Java项目：

bash
play eclipse

Docker部署示例

多服务集成测试

1. 将W3ACT数据库备份文件放置于integration-test/pgdump/w3act.pgdump（注意：数据库包含第三方个人信息，无法提供示例备份）

2. 启动PostgreSQL：

   bash
   docker-compose up -d postgres
   

3. 恢复数据库：

   bash
   docker-compose up pg_restore
   

4. 构建并运行w3act：

   bash
   docker-compose build
   docker-compose up w3act
   

注意：当前Docker Compose配置不包含OutbackCDX、Wayback或pdftohtmlex，部分页面可能加载缓慢或功能受限。

5. 本地开发（不构建Docker镜像）：

   bash
   activator -Dconfig.file=conf/dev-on-docker.conf -Dlogger.file=conf/logger-debug.xml clean start
   

API使用示例（Curl）

1. 登录：

   bash
   curl -c cookie.jar -i --data "email=user@example.org&password=PASS" https://localhost:9000/act/login
   

2. 通过API下载数据：

   bash
   curl -o 42.json -b cookie.jar https://localhost:9000/act/api/targets/42
   

子模块设置

bash
$ git submodule init
$ git config -l
$ git submodule update

故障排除

浏览器中出现SQL错误

1. 根据安装路径调整清理脚本路径并执行：

   bash
   cleanup.bat
   

2. 或执行：

   bash
   play clean
   

3. 手动删除项目中的所有"target"文件夹