LOCKSS Crawler Service

This is the REST Web Service that provides support for multple crawlers.

Note on branches

The master branch is for stable releases and the develop branch is for ongoing development.

Standard build and deployment

The LOCKSS cluster, including this project, is normally built and deployed using the LOCKSS Installer, which uses kubernetes.

You can find more information about the installation of the LOCKSS system in the LOCKSS system manual.

Development build and deployment

Clone the repo

git clone -b develop ssh://github.com/lockss/laaws-crawler-service.git

Create the Eclipse project (if so desired)

File -> Import... -> Maven -> Existing Maven Projects

Build the web service:

In the home directory of this project, where this README.md file resides, run mvn clean install.

This will run the tests as a pre-requisite for the build.

The result of the build is a so-called "uber JAR" file which includes the project code plus all its dependencies and which can be located via the symbolic link at

./target/current-with-deps.jar

Run the web service:

Run the LOCKSS Development Scripts project bin/runservice script in the home directory of this project, where this README.md file resides.

The log is at ./logs/app.log.

The API is documented at http://127.0.0.1:24660/swagger-ui.html.

The status of the web service may be obtained at http://127.0.0.1:24660/status.

The administration UI of the web service is at http://127.0.0.1:24661.