Skip to content

Commit 02eff9d

Browse files
dtheilerdtheiler
authored
Update README.md
1 parent b57c3c3 commit 02eff9d

File tree

1 file changed

+21
-83
lines changed

1 file changed

+21
-83
lines changed

‎README.md‎

Lines changed: 21 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -10,93 +10,31 @@ By creating an infrastructure that allows for social negotiation of semantic mea
1010
![alt tag](https://raw.githubusercontent.com/learning-layers/SocialSemanticServer/bba6324551551b41f43e3b630e2376ecde83c807/desc.jpg)
1111

1212
Please cite one of the [papers](https://github.com/learning-layers/SocialSemanticServer#references) if you use this software in one of your publications.
13-
## Download
14-
The source-code can be directly checked-out through this repository. It contains a Maven project to edit and build it.
1513

16-
## Documentation
17-
* for REST API description please have a look at Swagger's JSON-based REST API documentation in releases (i.e. `sss.package/api-docs`)
18-
19-
## SSS deployment from release packages
20-
* follow instructions for Java 8, Apache Tomcat 7, [Apache Solr 4.9] and MySQL 5.6 in chapters below
21-
* download desired release from within this repository (i.e. `https://github.com/learning-layers/SocialSemanticServer/releases`)
14+
## Install and Deployment
15+
* download desired release from release section
2216
* extract `sss.package.zip`
23-
* SSS deployment with REST API
24-
* copy `sss.package/sss.conf.yaml` to `/sssWorkDir/`
25-
* adapt conf to your needs
26-
* copy `sss.package/sss.adapter.rest.v3.war` to `Catalina Base/webapps`
27-
* start Tomcat
28-
* access Swagger UI from `http://localhost:8080/sss.adapter.rest.v3/`
29-
* access the REST API via requests to `http://localhost:8080/sss.adapter.rest.v3/rest/{API}/{OP or ID}`
17+
* install `Java 8` or higher from [Java Site](https://java.com/en/download/index.jsp) (optionally install Apache Solr
18+
* install `MySQL 5.6` or higher from [MySQL Site](http://www.mysql.com/downloads/)
19+
* have at least the following set in your `my.cnf`
20+
* [client]
21+
* default-character-set=utf8
22+
* [mysql]
23+
* default-character-set=utf8
24+
* [mysqld]
25+
* init-connect='SET NAMES utf8'
26+
* character-set-server = utf8
27+
* import `sss.package/sss.schema.sql` to setup `sss` scheme
28+
* copy `sss.package/sss.conf.yaml` to `/sssWorkDir/` and adapt
29+
* copy `sss.package/sss.dropwizard.conf.yaml` to `/sssWorkDir/` and adapt
30+
* copy `sss.package/sss.adapter.rest.v3.dropwizard.jar` to `/sssWorkDir/`
31+
* start sss via `/sssWorkDir/java -jar sss.adapter.rest.v3.dropwizard.jar server sss.dropwizard.conf.yaml`
32+
* access REST API via requests to `http://yourhost:yourport/rest/{API}/{OP or ID}`
3033
* `API`: REST resource to be targeted
31-
* `OP or ID`: path to the actual service call to be executed, e.g., GET to `http://localhost:8080/sss.adapter.rest.v3/rest/entities/{entity}` gets information for a certain entity
32-
33-
## SSS requirements
34-
35-
### Java 8
36-
* please use Java 8 or higher from [Java Site](https://java.com/en/download/index.jsp)
37-
38-
### Apache Maven 3
39-
* please use Maven 3 or higher from [Maven Site](http://maven.apache.org/download.cg)
40-
* check out the Maven installation guide at [Maven Guides](http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)
34+
* `OP or ID`: path to the actual service call to be executed, e.g., GET to `http://localhost:9000/rest/entities/{entity}` gets information for a certain entity
4135

42-
### Apache Tomcat 7
43-
* please use Tomcat 7 or higher from [Tomcat Site](http://tomcat.apache.org/download-70.cgi)
44-
45-
### Apache Solr 4.9
46-
* this guide was derived from [Apache Solr Reference Guide](http://tweedo.com/mirror/apache/lucene/solr/ref-guide/apache-solr-ref-guide-4.9.pdf)
47-
* download Solr from, e.g., [Solr Mirror](http://mirror2.klaus-uwe.me/apache/lucene/solr/4.9.0/)
48-
* decompress Solr package
49-
* rename folder for convenience to `solrPackage`
50-
* copy to `Solr Home` (e.g.: `/solr/`)
51-
* `/solrPackage/example/solr/`
52-
* copy to `Solr Home` `Lib` directory (e.g.: `/solr/lib/`)
53-
* `/solrPackage/contrib/`
54-
* `/solrPackage/dist/`
55-
* for certain bug-fixes for PDF extraction and indexing
56-
* upgrade in `Solr Home` `lib/contrib/extraction/`
57-
* `pdfbox-1.8.4.jar` to `pdfbox-1.8.6.jar`
58-
* `tika-core-1.5.jar` to tika-core-1.6.jar`
59-
* `tika-parsers-1.5.jar` to `tika-parsers-1.6.jar`
60-
* `tika-xmp-1.5.jar` to `tika-xmp-1.6.jar`
61-
* replace `schema.xml` and `solrconfig.xml` in `Solr Home` `Core's Conf` directory (e.g.: `/solr/collection1/conf`) with:
62-
* `sss.package/sss.app/solr_schema.xml`
63-
* `sss.package/sss.app/solr_solrconfig.xml`
64-
* adjust `solrconfig.xml` to have directives pointing to `Solr Home` `Lib` subfolders, e.g.:
65-
* `<lib dir="/solr/lib/contrib/extraction/lib" regex=".*\.jar" />`
66-
* `<lib dir="/solr/lib/dist/" regex="solr-cell-\d.*\.jar" />`
67-
* `<lib dir="/solr/lib/contrib/clustering/lib/" regex=".*\.jar" />`
68-
* `<lib dir="/solr/lib/dist/" regex="solr-clustering-\d.*\.jar" />`
69-
* `<lib dir="/solr/lib/contrib/langid/lib/" regex=".*\.jar" />`
70-
* `<lib dir="/solr/lib/dist/" regex="solr-langid-\d.*\.jar" />`
71-
* `<lib dir="/solr/lib/contrib/velocity/lib" regex=".*\.jar" />`
72-
* `<lib dir="/solr/lib/dist/" regex="solr-velocity-\d.*\.jar" />`
73-
* set user `tomcat7` as owner for `Solr Home` directory
74-
* stop Tomcat
75-
* edit Tomcat's `catalina.sh` (e.g.: `/usr/share/tomcat7/bin/catalina.sh`) to point to `Solr Home` directory
76-
* `export JAVA_OPTS="$JAVA_OPTS -Dsolr.solr.home=/solr"`
77-
* copy to `Tomcat` `Lib` dir: (e.g.: `/usr/share/tomcat7/lib`)
78-
* `/solrPackage/example/lib/ext/` contents
79-
* `/solrPackage/example/resources/log4j.properties`
80-
* adjust `log4j.properties` to your needs
81-
* copy to `Tomcat Webapps` directory (e.g.: `/var/lib/tomcat7/webapps/`)
82-
* `/solrPackage/example/webapps/solr.war`
83-
* start Tomcat
84-
85-
### MySQL 5.6
86-
* please use `MySQL 5.6` or higher from [MySQL Site](http://www.mysql.com/downloads/)
87-
* have at least the following set in your `my.cnf`
88-
* [client]
89-
* default-character-set=utf8
90-
* [mysql]
91-
* default-character-set=utf8
92-
* [mysqld]
93-
* init-connect='SET NAMES utf8'
94-
* character-set-server = utf8
95-
* either import `sss.package/sss.app/sss_schema.sql` to setup `sss` scheme or apply respective database migration script, e.g., `sss.package/sss.app/sss_schema_upgrade_6.0.0_6.0.1.sql`
96-
97-
## SSS deployment from source code
98-
* run `mvn clean install` on project `SocialSemanticServer` to have `adapter/adapter.rest/adapter.rest.v3/target/adapter.rest.v3.1.0-SNAPSHOT.war`
99-
* rename `adapter.rest.v3.1.0-SNAPSHOT.war` to `sss.adapter.rest.v3.war` and copy to `Tomcat webapps` directory
36+
## Documentation
37+
* for REST API description please have a look at Swagger's JSON-based REST API documentation in releases (i.e. `sss.package/api-docs`)
10038

10139
## References
10240
* S. Dennerlein, D. Kowald, E. Lex, D. Theiler, E. Lacic, T. Ley, V. Tomberg, A. Ruiz-Calleja [The Social Semantic Server: A Flexible Framework to Support Informal Learning at the Workplace](https://www.researchgate.net/publication/280920425_The_Social_Semantic_Server_A_Flexible_Framework_to_Support_Informal_Learning_at_the_Workplace#full-text), 2015. 15th International Conference on Knowledge Technologies and Data-driven Business (i-KNOW 2015), Graz, Austria

0 commit comments

Comments
 (0)