Skip to content

Commit

Permalink
Updates to correct markdown errors
Browse files Browse the repository at this point in the history
  • Loading branch information
beebs-systap committed Mar 14, 2019
1 parent 3434b68 commit 174e1c6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 26 deletions.
42 changes: 18 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## 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 and has a enterprise features for High Availability, Scale-out architecture, and [GPU Acceleration](https://www.blazegraph.com/product/gpu-accelerated/). It is in production use for Fortune 500 customers such as EMC, Autodesk, and many others. It is supporting key [Precision Medicine](http://www.syapse.com) 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](https://query.wikidata.org/). See the latest [Feature Matrix](http://www.blazegraph.com/product/).
## 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](http://www.syapse.com) 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](https://query.wikidata.org/).

![image](http://blog.blazegraph.com/wp-content/uploads/2015/07/blazegraph_by_systap_favicon.png)

Expand All @@ -9,11 +9,11 @@ Please see the release notes in [releases](bigdata/src/releases) for version cha

Please also visit us at our: [website](https://www.blazegraph.com), [wiki](https://wiki.blazegraph.com), and [blog](https://blog.blazegraph.com/).

Find an issue? Need help? See [JIRA](https://jira.blazegraph.com) or purchase [Support](https://www.blazegraph.com/buy).
Find an issue? Need help? See [JIRA](https://jira.blazegraph.com).

Reporting a security issue: [Security Reporting](Security.md).

###Quick Start with the Executable Jar
### Quick Start with the Executable Jar ###
Up and running with Blazegraph in under 30 seconds: [Quick Start](https://wiki.blazegraph.com/wiki/index.php/Quick_Start).

### Deploying in Production ###
Expand All @@ -34,20 +34,22 @@ There are three basic options:
1. **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](https://community.openhab.org/t/using-nginx-reverse-proxy-authentication-and-https/14542) and [Apache](https://stackoverflow.com/questions/5011102/apache-reverse-proxy-with-basic-authentication).

##### 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)[https://tomcat.apache.org/tomcat-8.0-doc/config/filter.html#CSRF_Prevention_Filter_for_REST_APIs] 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.
If you enable authentication and expose the Blazegraph workbench, you should also take steps to protect against CSRF. Tomcat8 provides a [CSRF filter](https://tomcat.apache.org/tomcat-8.0-doc/config/filter.html#CSRF_Prevention_Filter_for_REST_APIs) 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
### 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](https://wiki.blazegraph.com/wiki/index.php/MavenNotes).

###Samples and Examples
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
### Javadocs ###
Click here to view the lastest [API Javadocs](https://blazegraph.github.io/database/apidocs/index.html).

###Maven Central
### 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](https://wiki.blazegraph.com/wiki/index.php/MavenNotes) has notes on developing with Blazegraph Database source code and Maven.

```
Expand All @@ -74,13 +76,13 @@ If you'd just link the Blazegraph Database dependencies without any of the exter
</dependency>
```

###Deployers
### 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/) (`blazegraph-deb`), [RPM](blazegraph-rpm/) (`blazegraph-rpm`), and a [Tarball](blazegraph-tgz/) (`blazegraph-tgz`).

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

###Tinkerpop3
### Tinkerpop3 ###
Tinkerpop3 supports requires Java 1.8 and is now in a separate repository. See [Tinkerpop3](https://github.com/blazegraph/tinkerpop3). It is also available as Maven Central artifact.

```
Expand All @@ -92,19 +94,11 @@ Tinkerpop3 supports requires Java 1.8 and is now in a separate repository. See
```

###Triple Pattern Fragment (TPF) Server
There is a [Blazegraph Triple Pattern Fragment TPF](https://github.com/blazegraph/BlazegraphBasedTPFServer) server that supports [Linked Data Fragments](http://linkeddatafragments.org/).

```
<dependency>
<groupId>com.blazegraph</groupId>
<artifactId>BlazegraphBasedTPFServer</artifactId>
<version>0.1.0</version>
</dependency>
```
### Triple Pattern Fragment (TPF) Server ###
There is a [Blazegraph Triple Pattern Fragment TPF](https://github.com/hartig/BlazegraphBasedTPFServer) server that supports [Linked Data Fragments](http://linkeddatafragments.org/).

###Blazegraph Python Client
There is a Blazegraph Python Client [here] (https://github.com/blazegraph/blazegraph-python)
### Blazegraph Python Client ###
There is a Blazegraph Python Client [here](https://github.com/blazegraph/blazegraph-python)

###Blazegraph Dot Net RDF Client
### Blazegraph Dot Net RDF Client ###
There is a Blazegraph Dot Net RDF Client [here](https://github.com/blazegraph/blazegraph-dotnetrdf)
4 changes: 2 additions & 2 deletions Security.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
##Reporting a Blazegraph Security Issue##
## Reporting a Blazegraph Security Issue ##

For customers and Blazegraph users, please send an email to security [at] blazegraph.com to report a security issue. You may send an encrypted message using the public key below.

This alias is monitored on a daily basis. All security reports are acknowledged within 24 hours. Mitigations for reported security issues are made in a reasonable timeframe, which may be as quickly as 24 hours for high-severity issues.

###Public Key###
### Public Key ###
Please use the public key below for transmitting any sensitive information to the security alias.

```
Expand Down

0 comments on commit 174e1c6

Please sign in to comment.