Scripts to create and maintain an example Solr instance for Sciveyor development.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Charles Pence 437b0ff272
Update for the new sciveyor-tool.
9 months ago
data Initial import of the new Docker-based example. 1 year ago
.gitignore Initial import of the new Docker-based example. 1 year ago
COPYING Initial import of the new Docker-based example. 1 year ago
README.md Update for the new sciveyor-tool. 9 months ago
create Rename container to sciveyor-solr-dev. 1 year ago
delete Rename container to sciveyor-solr-dev. 1 year ago
load Update for the new sciveyor-tool. 9 months ago
start Rename container to sciveyor-solr-dev. 1 year ago
stop Rename container to sciveyor-solr-dev. 1 year ago

README.md

Sciveyor Logo

Sciveyor Solr Example

This repository contains sample data and some scripts you can use to maintain a sample Solr instance for use in developing Sciveyor.

To use these, you'll need to have:

  • Docker, installed and accessible via sudo
  • MongoDB, installed and accessible to your local user
  • Sciveyor's sciveyor-tool, installed and compiled
  • curl

Note that this process will create a MongoDB database called sciveyor-dev and a Solr data directory in ./solrdata. Both of these are meant to be automatically managed, and will be reset, deleted, or changed by these scripts without warning!

Scripts

  • Create a new Docker container: ./create

    This will spin up a new Docker container using our Solr Docker image.

  • Start the Docker container: ./start

    This will start the created Docker container, if it's not already running.

  • Stop the Docker container: ./stop

    This will stop the created Docker container, if running.

  • Delete the Docker container: ./delete

    This will delete the created Docker container, if it exists.

  • Load data into the Docker container: ./load $MONGO_TOOL

    This will load data into the created Docker container from the data folder, via the given path to an installed copy of mongo-tool.

Versions

If you're looking for a Solr instance that works with:

  • Sciveyor 1.x (version of Sciveyor starting in 2021): the main branch of this repository (you are here!)
  • RLetters 3.x (versions of RLetters starting in May, 2018): another repository
  • RLetters 2.x (versions of RLetters before May, 2018): another repository

Licenses

The data here is taken from two sources: the PLoS Neglected Tropical Diseases journal, available under the CC-BY license, and from Project Gutenberg, available under the Project Gutenberg license.

Other code and scripts are available under the MIT License.