First documentation in README.md #355
Conversation
| <details> | ||
| <summary><b>Run using Docker</b></summary> | ||
|
|
||
| Download or clone the project from the HeFQUIN repository and navigate to the project root in a terminal. Build and run the latest version of the engine using: |
There was a problem hiding this comment.
What does "Download" mean? Downloading the ZIP / TAR.GZ file of one of the releases?
Assuming yes, then this should be the default option that we advertise here in the quick start guide. The option to clone the repo may be mentioned briefly, with a reference to the corresponding part of the detailed documentation pages.
| The optional build argument (`TAG`) can used to build the image from a specific release: | ||
| ```yml | ||
| hefquin: | ||
| build: | ||
| context: . | ||
| args: | ||
| TAG: <insert tag> | ||
| ports: | ||
| - "8080:8080" | ||
| ``` | ||
|
|
||
| The engine can be configured by mounting custom configuration files when starting up the container: | ||
| ```yml | ||
| hefquin: | ||
| build: . | ||
| ports: | ||
| - "8080:8080" | ||
| volumes: | ||
| - ./example/config.properties:/usr/local/tomcat/webapps/ROOT/config.properties | ||
| - ./example/ExampleEngineConf.ttl:/usr/local/tomcat/webapps/ROOT/ExampleEngineConf.ttl | ||
| - ./example/ExampleFedConf.ttl:/usr/local/tomcat/webapps/ROOT/ExampleFedConf.ttl | ||
| ``` | ||
|
|
||
| where the `config.properties` file has the following structure: | ||
| ```bash | ||
| ENGINE_CONF_FILE=ExampleEngineConf.ttl # the engine configuration file | ||
| FED_CONF_FILE=ExampleFedConf.ttl # the federation configuration file | ||
| ``` |
There was a problem hiding this comment.
These things should also be moved to the detailed documentation pages, and here we mention only briefly that these things are possible and refer to the documentation pages for the details.
| FED_CONF_FILE=ExampleFedConf.ttl # the federation configuration file | ||
| ``` | ||
|
|
||
| By default the service exposes a SPARQL endpoint at `http://localhost:8080/sparql`. |
There was a problem hiding this comment.
Is this relevant only for the Docker option? If not, we should move up to the general part about the Web service (i.e., right before the collapsible subsections).
| __Option 1:__ Clone the project from the HeFQUIN repository and navigate to the project root in a terminal. Build the latest version of the engine using: | ||
| ```bash | ||
| $ mvn clean package | ||
| ``` | ||
| To use a specific release, checkout the tag before building: | ||
| ```bash | ||
| $ git checkout <insert tag> | ||
| $ mvn clean package | ||
| ``` | ||
|
|
||
| __Option 2:__ Download a JAR file from the set of available releases (see [Releases](https://github.com/LiUSemWeb/HeFQUIN/releases)). |
There was a problem hiding this comment.
I would not advertise option 1 here but move it to the detailed documentation, and here only briefly mention the existence of this option, with a reference to the corresponding part of the documentation.
There was a problem hiding this comment.
An issue about the text for option 2 is that there are no JAR files at https://github.com/LiUSemWeb/HeFQUIN/releases -- Is this something that we need to enable somehow? Or can the creation of releases on the Github Website only produce ZIP and TAR.GZ files?
|
|
||
| Start the server in a terminal by running the following command: | ||
| ```bash | ||
| java -cp target/HeFQUIN-x.y.z-SNAPSHOT.jar se.liu.ida.hefquin.service.HeFQUINServer |
There was a problem hiding this comment.
This works only for option 1 above, not for option 2 (assuming option 2 is indeed about downloading a JAR file).
| The engine can be configured by modifying the `config.properties` file in the working directory. The `config.properties` file has the following structure: | ||
| ```bash | ||
| ENGINE_CONF_FILE=ExampleEngineConf.ttl # the engine configuration file | ||
| FED_CONF_FILE=ExampleFedConf.ttl # the federation configuration file | ||
| ``` |
There was a problem hiding this comment.
Like above, perhaps that's something to be moved to the detailed documentation pages a well.
| ENGINE_CONF_FILE=ExampleEngineConf.ttl # the engine configuration file | ||
| FED_CONF_FILE=ExampleFedConf.ttl # the federation configuration file | ||
| ``` | ||
| > __NOTE__: The servlet will need to be restarted for any changes in the engine configuration to take effect. |
There was a problem hiding this comment.
Is this relevant only for the 'separate servlet container' case?
| __Option 1:__ Clone the project from the HeFQUIN repository and navigate to the project root in a terminal. Build the latest version of the engine using: | ||
| ```bash | ||
| $ mvn clean package | ||
| ``` | ||
| To use a specific release, checkout the tag before building: | ||
| ```bash | ||
| $ git checkout <insert tag> | ||
| $ mvn clean package | ||
| ``` |
There was a problem hiding this comment.
Similar to above, this option should be moved to the detailed documentation, and then only briefly referred to from here.
| $ mvn clean package | ||
| ``` | ||
|
|
||
| __Option 2:__ Download a JAR file from the set of available releases (see [Releases](https://github.com/LiUSemWeb/HeFQUIN/releases)). |
|
|
||
| Example usage: | ||
| ```bash | ||
| java -cp target/HeFQUIN-0.0.4-SNAPSHOT.jar se.liu.ida.hefquin.cli.RunQueryWithoutSrcSel \ |
There was a problem hiding this comment.
This doesn't work if a JAR has been downloaded.
Related to #346.