(Work in Progress)

The easiest way to experiment with LOCKSS 2.0, both general operation and the REST APIs, is with the runcluster framework, which runs a set of LOCKSS services in a non-container environment.

• Obtain laaws-dev-scripts:
  • Either clone the project and switch to the develop branch:
    • git clone https://github.com/lockss/laaws-dev-scripts.git
    • git checkout develop
  • or fetch and unzip https://github.com/lockss/laaws-dev-scripts/archive/refs/heads/develop.zip
    (If you intend to work with this framework over time, it's better to use git clone as that will make it easier to obtain updates.)
• See directions in the runcluster README. In most cases it's best to run the snapshot artifacts. (Note: currently Java 17 must be used.)
• The services' REST APIs can be accessed at the following URLs. Append swagger-ui.html to these URLs to access a tool to interact with the APIs in a browser.
  • Repository Service: http://localhost:24610/
  • Config Service: http://localhost:24620/
  • Poller Service: http://localhost:24630/ The services' interim UIs can be accessed at these URLs.
  • Config Service: http://localhost:24621/
  • Poller Service: http://localhost:24631/
• By default both REST and UI are configured to require basic authentication; use the username/password lockss-u/lockss-p.
• Scenarios
  • To run the cluster as a node in an existing LOCKSS network (PLN or GLN), add -p <props-url> to the ./start command line. (If the props are hosted on LOCKSS' prop server (props.lockss.org), this may be abbreviated -p lockss:<pln-name>). This will load the PLN's plugins.
  • To use the cluster to test new plugins, Create a Plugins Project, package it and pass the jar name(s) to ./start as explained in the runcluster README.
  • To experiment with Named AUs, bypassing the crawler and storing content directly into the repository, no plugins are needed. See Using the REST APIs.