Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "StatET/R Help Server"

(Add category)
(Move instructions to README.md)
Line 4: Line 4:
 
* RJSrv (e.g. GNU R with https://gitlab.com/walware/de.walware.rj-server.gr)
 
* RJSrv (e.g. GNU R with https://gitlab.com/walware/de.walware.rj-server.gr)
  
== Installation & Configuration ==
+
== Installation ==
  
 
* Download and unpack the file <code>statet-rhelpserver-*.zip</code>
 
* Download and unpack the file <code>statet-rhelpserver-*.zip</code>
* Edit the configuration(s) for the R environments in the folder <code>renvs</code>:
 
** One configuration file per R environment
 
** The name of the file is the id of the R environment
 
  
== Run the Server ==
+
== Usage ==
* Just start the jar:
+
java -jar org.eclipse.statet.rhelp.server.jar &
+
  
=== Special modes ===
+
See README.md file
<code>-index-and-exit</code> - creates or updates the help index only
+
 
+
=== Options ===
+
The server is based on Spring Boot; see documentation of Spring Boot e.g. how to configure the webserver.
+
 
+
== Configuration in the IDE ==
+
To use the server in the IDE, specify the URI as follows:
+
<nowiki>http://<name or ip>:<port>/<env id></nowiki>
+
For example:
+
<nowiki>http://serverwithhelp:8080/r35</nowiki>
+
 
+
The following defaults can be optionally omitted:
+
** <code><port></code> = 80
+
** <code><env id></code> = default
+
So <code><nowiki>http://serverwithhelp/</nowiki></code> is equal to <code><nowiki>http://serverwithhelp:80/default</nowiki></code>
+
  
 
[[Category:StatET]]
 
[[Category:StatET]]

Revision as of 09:00, 26 March 2019

Requirements

Installation

  • Download and unpack the file statet-rhelpserver-*.zip

Usage

See README.md file

Back to the top