Fuseki SPARQL server
Run Fuseki as a systemd service
As root got
cd /usr/local/src
Download & untar
wget https://apache.redkiwi.nl/jena/binaries/apache-jena-fuseki-3.15.0.tar.gz tar xfvz apache-jena-fuseki-3.15.0.tar.gz cd apache-jena-fuseki-3.15.0
Fuseki File Layout
I will follow the Filesystem layout suggested by the official documentation for [1] for running Fuseki as a service
Environment Variable Default Setting FUSEKI_HOME /usr/share/fuseki FUSEKI_BASE /etc/fuseki
- FUSEKI_HOME(Distribution area) – a is essentially the fuseki-server binary and a few helper scripts
- FUSEKI_BASE(Runtime area) – is a directory that contains the configuration, dbs, logs - which should be backup and not changed with updates of the Fuseki binaries.
So let's go ahead and create those directories and move the corresponding files to the right dir
mkdir /usr/share/fuseki mkdir /etc/fuseki
cp {fuseki,fuseki-server,fuseki-server.bat,fuseki-server.jar,fuseki.war,bin,webapp} /usr/share/fuseki/
cp -r run/* /etc/fuseki/
cp log4j2.properties /etc/fuseki/
And we can make a test run by running:
/usr/share/fuseki/fuseki-server
And checking the if the server is up by visiting http://localhost:3030/index.html
Service file
Inside the untared dir /usr/local/src/apache-jena-fuseki-3.15.0 you can find the file fuseki.service
This file should be copied to /etc/system.d/system and edited in order to run Fuseki as a service. The file itself is quite self explanatory, so I will only write here my changes, which match the file system structure I went for.
cp fuseki.service /etc/systemd/system
vi /etc/systemd/system/fuseki.service
[Unit] Description=Fuseki [Service] # Edit environment variables to match your installation Environment=FUSEKI_HOME=/usr/share/fuseki Environment=FUSEKI_BASE=/etc/fuseki # Edit the line below to adjust the amount of memory allocated to Fuseki Environment=JVM_ARGS=-Xmx4G # Edit to match your installation ExecStart=/usr/share/fuseki/fuseki-server # Run as user "fuseki" User=root Restart=on-abort # Java processes exit with status 143 when terminated by SIGTERM, this # should be considered a successful shutdown SuccessExitStatus=143 ### By default, the service logs to journalctl only. StandardOutput=file:/var/log/fuseki/access.log StandardError=file:/var/log/fuseki/stderrout.log #StandardOutput=syslog #StandardError=syslog #SyslogIdentifier=fuseki ### This logs to syslog. If, e.g., rsyslogd is used, you can provide a file ### /etc/rsyslog.d/fuseki.conf, consisting of the following two lines (uncommented) #if $programname == 'fuseki' then /var/log/fuseki/stderrout.log #if $programname == 'fuseki' then stop [Install] WantedBy=multi-user.target
Create logs dir:
mkdir /var/log/
Enable and run the service:
systemctl enable fuseki systemctl start fuseki
Check it's status
systemctl status fuseki
And again check its web UI at http://localhost:3030
- you try to create a db a make and perform and INSERT statement, which be stored in
/etc/fuseki/databases/databasename/
Config
Security
Fuseki security settings are defined in file /etc/fuseki/shiro.ini [2]
Here I can change the default admin password
And also the rights to Fuseki Administative HTTP protocol[3] and access to the existing DBs.
I will allow the db test to be queried by anyone but only updated by the locahost, so that the SMW can write to it, but requests coming from outside cannot update it, but can query, with:
/test/query = anon /test/update = localhostFilter
Full shiro.ini
# Licensed under the terms of http://www.apache.org/licenses/LICENSE-2.0 [main] ssl.enabled = false plainMatcher=org.apache.shiro.authc.credential.SimpleCredentialsMatcher #iniRealm=org.apache.shiro.realm.text.IniRealm iniRealm.credentialsMatcher = $plainMatcher localhostFilter=org.apache.jena.fuseki.authz.LocalhostFilter [users] # Implicitly adds "iniRealm = org.apache.shiro.realm.text.IniRealm" admin=pw123 [roles] [urls] # All admin operations have URL paths starting /$/ to avoid clashes with dataset names and this prefix is reserved for the Fuseki control functions. /$/status = anon /$/ping = anon /$/stats/** = anon # test db /test/query = anon /test/update = localhostFilter # everything else only accessible to localhost /** = localhostFilter
To test it I can perform:
A query coming from both local and remote hosts, where both should succeed:
curl http://localhost:3030/test/query -X POST --data 'query=PREFIX+foaf%3A+%3Chttp%3A%2F%2Fxmlns.com%2Ffoaf%2F0.1%2F%3E%0APREFIX+country%3A+%3Chttp%3A%2F%2Feulersharp.sourceforge.net%2F2003%2F03swap%2Fcountries%23%3E%0ASELECT+*%0A%7B%0A+%3Fs+foaf%3Aname+%22Test%22%40en+.%0A%7D' -H 'Accept: application/sparql-results+json,*/*;q=0.9'
curl http://10.0.0.20:3030/test/query -X POST --data 'query=PREFIX+foaf%3A+%3Chttp%3A%2F%2Fxmlns.com%2Ffoaf%2F0.1%2F%3E%0APREFIX+country%3A+%3Chttp%3A%2F%2Feulersharp.sourceforge.net%2F2003%2F03swap%2Fcountries%23%3E%0ASELECT+*%0A%7B%0A+%3Fs+foaf%3Aname+%22Test%22%40en+.%0A%7D' -H 'Accept: application/sparql-results+json,*/*;q=0.9'
And an update, which should succeed when coming from localhost and fail when coming from remote
curl http://localhost:3030/test -X POST --data 'update=PREFIX+foaf%3A+%3Chttp%3A%2F%2Fxmlns.com%2Ffoaf%2F0.1%2F%3E%0APREFIX+country%3A+%3Chttp%3A%2F%2Feulersharp.sourceforge.net%2F2003%2F03swap%2Fcountries%23%3E%0AINSERT+DATA%0A%7B%0A+country%3Aooo+foaf%3Aname+%22OOOOO%22%40en+.%0A%7D' -H 'Accept: text/plain,*/*;q=0.9'
curl http://10.0.20.2:3030/test -X POST --data 'update=PREFIX+foaf%3A+%3Chttp%3A%2F%2Fxmlns.com%2Ffoaf%2F0.1%2F%3E%0APREFIX+country%3A+%3Chttp%3A%2F%2Feulersharp.sourceforge.net%2F2003%2F03swap%2Fcountries%23%3E%0AINSERT+DATA%0A%7B%0A+country%3Aooo+foaf%3Aname+%22OOOOO%22%40en+.%0A%7D' -H 'Accept: text/plain,*/*;q=0.9'
Logging
Apache Fuseki Logging is performed via SLF4J over Apache Log4J2.
The Fuseki engine looks for the log4j2 configuration, in different locations, but I will stick with:
- file
log4j2.propertiesin the directory defined by FUSEKI_BASE:/etc/fuseki
log4j2.properties was in previous steps copied to /etc/fuseki/ and includes the default logging settings.
Backups
It is possible to send a POST request for Fuseki to create a backup of a database, with
curl http://localhost:3030/$/backup/test -X POST -H 'Accept: application/sparql-results+json,*/*;q=0.9'
Here the test db will be backup up, and stored in /etc/fuseki/backups under a gzip-compressed N-Quads file test_2020-05-23_14-42-41.nq.gz
Which, when decompressed, will show a contained list of triples which makes up the db:
gzip -d test_2020-05-23_14-42-41.nq.gz
cat test_2020-05-23_14-42-41.nq
<http://eulersharp.sourceforge.net/2003/03swap/countries#zx> <http://xmlns.com/foaf/0.1/name> "Zexix"@en . <http://eulersharp.sourceforge.net/2003/03swap/countries#zy> <http://xmlns.com/foaf/0.1/name> "Zyz"@en . <http://eulersharp.sourceforge.net/2003/03swap/countries#ou> <http://xmlns.com/foaf/0.1/name> "Ouoaoo"@en . ...
Errors
2020-05-19 20:47:16,859 main ERROR Unable to locate plugin type for Loggers 2020-05-19 20:47:16,859 main ERROR Unable to locate plugin type for Appenders 2020-05-19 20:47:16,859 main ERROR Unable to locate plugin type for ThresholdFilter 2020-05-19 20:47:16,861 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,861 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,861 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,862 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,862 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,862 main ERROR Unable to locate plugin for AppenderRef 2020-05-19 20:47:16,862 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,862 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,863 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,863 main ERROR Unable to locate plugin for Logger 2020-05-19 20:47:16,863 main ERROR Unable to locate plugin for AppenderRef 2020-05-19 20:47:16,863 main ERROR Unable to locate plugin for Root 2020-05-19 20:47:16,863 main ERROR Unable to locate plugin for Loggers 2020-05-19 20:47:16,864 main ERROR Unable to locate plugin for PatternLayout 2020-05-19 20:47:16,864 main ERROR Unable to locate plugin for Console 2020-05-19 20:47:16,864 main ERROR Unable to locate plugin for PatternLayout 2020-05-19 20:47:16,864 main ERROR Unable to locate plugin for Console 2020-05-19 20:47:16,864 main ERROR Unable to locate plugin for Appenders 2020-05-19 20:47:16,865 main ERROR Unable to locate plugin for ThresholdFilter
systemctl daemon-reload
- ↑ https://jena.apache.org/documentation/fuseki2/fuseki-layout.html
- ↑ Fhttps://jena.apache.org/documentation/fuseki2/fuseki-security.html
- ↑ https://jena.apache.org/documentation/fuseki2/fuseki-server-protocol.html
