Skip to content

Latest commit

 

History

History
104 lines (72 loc) · 7.77 KB

README.md

File metadata and controls

104 lines (72 loc) · 7.77 KB

Welcome to the Blazegraph Database

Blazegraph™ DB is a ultra high-performance graph database supporting Blueprints and RDF/SPARQL APIs. It supports up to 50 Billion edges on a single machine. It is in production use for Fortune 500 customers such as EMC, Autodesk, and many others. It is supporting key Precision Medicine applications and has wide-spread usage for life science applications. It is used extensively to support Cyber anaytics in commercial and government applications. It powers the Wikimedia Foundation's Wikidata Query Service.

image

Please see the release notes in releases for version changes.

Sign up to get the latest news on Blazegraph.

Please also visit us at our: website, wiki, and blog.

Find an issue? Need help? See JIRA.

Reporting a security issue: Security Reporting.

Quick Start with the Executable Jar

Up and running with Blazegraph in under 30 seconds: Quick Start.

Deploying in Production

Blazegraph is designed to be easy to use and get started. It ships without SSL or authentication by default for this reason. For production deployments, we strongly recommend you enable SSL, authentication, and appropriate network configurations. There are some helpful links below to enable you to do this.

Enabling SSL support

To enable SSL support, uncomment the example jetty.xml and configure it for your local keystore.

Configuration Authentication

By default, Blazegraph ships without authentication enabled. This is great for developing, getting started, and doing research with Blazegraph. However, it's not recommended for any production deployment. To configuration authentication, you must configure it either within the web app container or via a reverse-proxy configuration.

Note that the Blazegraph namespace feature for multi-tenancy does not provide security isolation. Users that can access the base URI of the server can access any of the available namespaces. You can further restrict this through a combination of authentication configuration and restricting access to specific namespace URIs, i.e. /blazegraph/namespace/NAMESPACE/sparql.

There are three basic options:

  1. Configuring Jetty Authentication for a standalone Jetty deployment: Follow the jetty guide to configure authentication for the jetty.xml you use to deploy the server by uncommenting the <Get name="securityHandler"> section. You'll need to create a realm.properties and update the jetty.xml to point to its location on the filesystem. Then configure the web.xml to uncomment the security-constraint.
  2. Configuring Tomcat Authentication for a standalone Tomcat deployment: First configure a Tomcat Realm with your choice of authentication method (JDBC, JNDI, etc.). Then configure the web.xml to uncomment the security-constraint.
  3. Setup a reverse-proxy configuration with authentication: You can setup an http or https reverse proxy configuration that has authentication and forward requests to the local Blazegraph instance (typically running on localhost:9999). This is a good option with Nginx and Apache.
Mitigating Cross-Site Request Forgery (CSRF)

If you enable authentication and expose the Blazegraph workbench, you should also take steps to protect against CSRF. Tomcat8 provides a CSRF filter that can be configured. For Jetty, if you configure authentication the default value for SecurityHandler.setSessionRenewedOnAuthentication(true) can also be used. CSRF protection may require REST clients to implement HTTP headers to be used to interact with the service.

Building the code

As a quick start, run mvn install -DskipTests or the utility script ./scripts/mavenInstall.sh .

For more detailed maven information see the wiki.

If you build with Java 7, you need to add Maven options for TLS 1.2, i.e. export MAVEN_OPTS="-Dhttps.protocols=TLSv1.2".

Samples and Examples

There are code samples and examples to get started with the Blazegraph Database [here] (https://github.com/blazegraph/blazegraph-samples). Tinkerpop3 examples are included directly within the Tinkerpop3 repository per below.

Javadocs

Click here to view the lastest API Javadocs.

Maven Central

Starting with the 2.0.0 release, the Blazegraph Database is available on Maven Central. To include the core platform and dependencies, include the artifact below in your dependencies. Developing with Maven has notes on developing with Blazegraph Database source code and Maven.

    <dependency>
        <groupId>com.blazegraph</groupId>
        <artifactId>bigdata-core</artifactId>
        <version>2.0.0</version>
    </dependency>
    <!-- Use if Tinkerpop 2.5 support is needed ; See also Tinkerpop3 below. -->
    <dependency>
        <groupId>com.blazegraph</groupId>
        <artifactId>bigdata-blueprints</artifactId>
        <version>2.0.0</version>
    </dependency>

If you'd just link the Blazegraph Database dependencies without any of the external libraries, use the bigdata-runtime artifact.

    <dependency>
        <groupId>com.blazegraph</groupId>
        <artifactId>bigdata-runtime</artifactId>
        <version>2.0.0</version>
    </dependency>

Deployers

Starting with 2.0.0, the default context path for deployment is http://localhost:9999/blazegraph/. There are also Maven artifacts for WAR deployers (blazegraph-war), executable Jar files (blazegraph-jar), Debian Package (blazegraph-deb), RPM (blazegraph-rpm), and a Tarball (blazegraph-tgz).

The bigdata-war and bigdata-jar artifacts are included for legacy purposes and use the /bigdata/ context path.

Tinkerpop3

Tinkerpop3 supports requires Java 1.8 and is now in a separate repository. See Tinkerpop3. It is also available as Maven Central artifact.

    <dependency>
        <groupId>com.blazegraph</groupId>
        <artifactId>blazegraph-gremlin</artifactId>
        <version>1.0.0</version>
    </dependency>
    

Triple Pattern Fragment (TPF) Server

There is a Blazegraph Triple Pattern Fragment TPF server that supports Linked Data Fragments.

Blazegraph Python Client

There is a Blazegraph Python Client here

Blazegraph Dot Net RDF Client

There is a Blazegraph Dot Net RDF Client here