You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by an...@apache.org on 2014/03/24 16:58:15 UTC
svn commit: r1580893 - in /jena/branches/jena-fuseki-new-ui/docs:
fuseki-configuration.md fuseki-main.md
Author: andy
Date: Mon Mar 24 15:58:14 2014
New Revision: 1580893
URL: http://svn.apache.org/r1580893
Log:
Documentation
Modified:
jena/branches/jena-fuseki-new-ui/docs/fuseki-configuration.md
jena/branches/jena-fuseki-new-ui/docs/fuseki-main.md
Modified: jena/branches/jena-fuseki-new-ui/docs/fuseki-configuration.md
URL: http://svn.apache.org/viewvc/jena/branches/jena-fuseki-new-ui/docs/fuseki-configuration.md?rev=1580893&r1=1580892&r2=1580893&view=diff
==============================================================================
--- jena/branches/jena-fuseki-new-ui/docs/fuseki-configuration.md (original)
+++ jena/branches/jena-fuseki-new-ui/docs/fuseki-configuration.md Mon Mar 24 15:58:14 2014
@@ -1,16 +1,155 @@
# Configuring Fuseki
-Config files
+Configuration consists of definign the data services (data and actiosn available on the data) together with configuring the server. Explcitily configuring the server is often unnecessary.
-Fuseki version 2 in
+The data services configuration can coem from:
-## Relationship to Fuseki 1 configuration
+1. The directory `FUSEKI_BASE/configuration/` with one data service assembler per file (includes endpoint details and the dataset description.)
+2. The system database. This incldues uplaoded assembler files. It also keeps the state of each data service (whetehr it's active or offline).
+3. The service configuration file. For compabibility, the service configuration file can also have data services. [See below](#relationship-to-fuseki-1-configuration).
+4. The command line, if not running as a web application from a .war file.
-Configurations from Fuseki 1, wheer all daatset and server setup is in a
-single configuration file, will stil work. It is less flexible
-(you can't restart these services after stopping them in a running server).
+`FUSEKI_BASE` is the location of the [Fuseki run area](#fuseki-layout.html).
-To convert a Fuseki 1 configuration setup to Fuseki 2 style:
+## Data Service assembler
-1. Move each data service assembler and put in it's own file under `FUSEKI_BASE/configuration/`
+See [Fuseki Data Services](fuseki-data-services.html) for the architecture of data services.
+See [Fuseki Security](fuseki-security.html) for more information on security.
+
+## Fuseki Configuration File
+
+A Fuseki server can be set up using a configuration file. The
+command-line arguments for publishing a single dataset are a short
+cut that, internally, builds a default configuration based on the
+dataset name given.
+
+The configuration is an RDF graph. One graph consists of one server
+description, with a number of services, and each service offers a
+number of endpoints over a dataset.
+
+The example below is all one file (RDF graph in Turtle syntax)
+split to allow for commentary.
+
+### Prefix declarations
+
+Some useful prefix declarations:
+
+ @prefix fuseki: <http://jena.apache.org/fuseki#> .
+ @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+ @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+ @prefix tdb: <http://jena.hpl.hp.com/2008/tdb#> .
+ @prefix ja: <http://jena.hpl.hp.com/2005/11/Assembler#> .
+ @prefix : <#> .
+
+### Assembler Initialization
+
+All datasets are described by
+[assembler descriptions](../assembler/index.html).
+Assemblers provide an extensible way of describing many kinds of
+objects.
+
+### Defining the service name and endpoints available
+
+Each data ervice assembler defines:
+
+* The base name
+* The operations and endpoint names
+* The dataset for the RDF data.
+
+This example offers SPARQL Query, SPARQL Update and SPARQL Graph
+Store protocol, as well as file upload.
+
+The base name is `/ds`.
+
+ ## Updatable in-memory dataset.
+
+ <#service1> rdf:type fuseki:Service ;
+ fuseki:name "ds"Â ; # http://host:port/ds
+ fuseki:serviceQuery "sparql"Â ; # SPARQL query service
+ fuseki:serviceQuery "query"Â ; # SPARQL query service (alt name)
+ fuseki:serviceUpdate "update"Â ; # SPARQL update service
+ fuseki:serviceUpload "upload"Â ; # Non-SPARQL upload service
+ fuseki:serviceReadWriteGraphStore "data"Â ; # SPARQL Graph store protocol (read and write)
+ # A separate read-only graph store endpoint:
+ fuseki:serviceReadGraphStore "get"Â ; # SPARQL Graph store protocol (read only)
+ fuseki:dataset <#dataset>Â ;
+ .
+
+`<#dataset>` refers to a dataset description in the same file.
+
+### Read-only service
+
+This example offers only read-only endpoints (SPARQL Query and HTTP GET
+SPARQl Graph Store protocol).
+
+This service offers read-only access to a dataset with a single
+graph of data.
+
+ <#service2> rdf:type fuseki:Service ;
+ fuseki:name "/ds-ro"Â ; # http://host:port/da-ro
+ fuseki:serviceQuery "query"Â ; # SPARQL query service
+ fuseki:serviceReadGraphStore "data"Â ; # SPARQL Graph store protocol (read only)
+ fuseki:dataset <#dataset>Â ;
+ .
+
+### Dataset
+
+#### In-memory
+
+An in-memory dataset, with data in the default graph taken from a local file.
+
+ <#books> rdf:type ja:RDFDataset ;
+ rdfs:label "Books"Â ;
+ ja:defaultGraph
+ [ rdfs:label "books.ttl"Â ;
+ a ja:MemoryModel ;
+ ja:content [ja:externalContent <file:Data/books.ttl> ]Â ;
+ ]Â ;
+ .
+
+#### TDB
+
+ <#dataset> rdf:type tdb:DatasetTDBÂ ;
+ tdb:location "DB"Â ;
+ # Query timeout on this dataset (1s, 1000 milliseconds)
+ ja:context [ ja:cxtName "arq:queryTimeout"Â ; ja:cxtValue "1000" ]Â ;
+ # Make the default graph be the union of all named graphs.
+ ## tdb:unionDefaultGraph true ;
+ .
+
+#### Inference
+
+> @@
+
+## Server Configuration
+
+If you need to load additional classes, or set global parameters, then these go in
+`FUSEKI_BASE/config.ttl`.
+
+Additional classes can not be loaded if running as a `.war` file. You will
+need to create a custom `.war` file consisting of the contents of the Fuseki
+web application and the additional classes
+
+### Server Section
+
+ [] rdf:type fuseki:Server ;
+ # Server-wide context parameters can be given here.
+ # For example, to set query timeouts: on a server-wide basis:
+ # Format 1: "1000" -- 1 second timeout
+ # Format 2: "10000,60000" -- 10s timeout to first result, then 60s timeout to for rest of query.
+ # See java doc for ARQ.queryTimeout
+ # ja:context [ ja:cxtName "arq:queryTimeout"Â ; ja:cxtValue "10000" ]Â ;
+
+ # Load custom code (rarely needed)
+ # ja:loadClass "your.code.Class"Â ;
+ .
+
+## Compatibility with Fuseki 1 configuration
+
+Configurations from Fuseki 1, where all dataset and server setup is in a
+single configuration file, will still work. It is less flexible
+(you can't restart these services after stopping them in a running server)
+and user should plan to migrate to the new layout.
+
+To convert a Fuseki 1 configuration setup to Fuseki 2 style, move each data service assembler and put in it's own file under `FUSEKI_BASE/configuration/`
Modified: jena/branches/jena-fuseki-new-ui/docs/fuseki-main.md
URL: http://svn.apache.org/viewvc/jena/branches/jena-fuseki-new-ui/docs/fuseki-main.md?rev=1580893&r1=1580892&r2=1580893&view=diff
==============================================================================
--- jena/branches/jena-fuseki-new-ui/docs/fuseki-main.md (original)
+++ jena/branches/jena-fuseki-new-ui/docs/fuseki-main.md Mon Mar 24 15:58:14 2014
@@ -50,6 +50,14 @@ preference to any older versions or of d
Fuseki requires Java7.
+**Fuseki download files**
+
+Filename | Description
+--------- | -----------
+`fuseki-*VER*.distribution.zip` | Fuseki download, includes everything.
+`fuseki-*VER*-server.jar` | Fuseki server, as an executable jar.
+`fuseki-*VER*-server.war` | Fuseki server, as a web application archive (.war) file.
+
> _@@ Not ready yet_
It is also available as a Java web application WAR file via maven.