Skip to content
This repository has been archived by the owner on Sep 2, 2020. It is now read-only.

Latest commit

 

History

History
88 lines (56 loc) · 3.58 KB

README.md

File metadata and controls

88 lines (56 loc) · 3.58 KB
Raw

Dependency Status

Crawl_J

This repository contains the Maven crawlers for VersionEye and requires Maven 3.3.9. This project contains:

  • A Maven Crawler which works via HTML. It can crawl the HTML representation of a Maven repository
  • RabbitMQ consumers/workers for HTML/Index crawlers.

There is always 1 crawler which walks ever through a maven index or it's HTML representation but doesn't download and parse any pom.xml files. It only sends the coordinates to a Queue (RabbitMQ). There can be N consumers/workers which do the heavy lifting, the downloading and parsing of the pom.xml files. That way it's relatively easy to scale the crawling processes.

Start the backend services for VersionEye

This project contains a docker-compose.yml file which describes the backend services of VersionEye. You can start the backend services like this:

docker-compose up -d

That will start:

  • MongoDB
  • RabbitMQ
  • ElasticSearch
  • Memcached

For persistence you should comment in and adjust the mount volumes in docker-compose.yml for MongoDB and ElasticSearch. If you are not interested in persisting the data on your host you can let it untouched.

Shutting down the backend services works like this:

docker-compose down

MongoDB Config

As primary database we are using MongoDB. To make this project work you need to configure the MongoDB connection in versioneye_maven_crawler/src/main/resources/mongo.properties. If you run MongoDB as a single instance, only fill out the first 3 lines.

RabbitMQ Config

To configure the RabbitMQ connection adjust the settings in versioneye_maven_crawler/srm/main/resources/settings.properties.

maven_index_worker

To start the RabbitMQ consumer/worker for the maven indexer run this command:

mvn crawl:maven_index_worker

That will spin up a RabbitMQ worker which waits for messages from the maven-indexer project.

html_worker

To start the RabbitMQ consumer/workers for the maven HTML crawler run this command:

mvn crawl:html_worker

That will spin up a RabbitMQ worker which waits for messages from the HTML index crawler.

Support

For commercial support send a message to [email protected].

License

this project is licensed under the MIT license!

Copyright (c) 2016 VersionEye GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.