What is a GUI plugin?
A plugin can be used to redirect an HTTP stream received by FlowerDocs GUI to another URL. To achieve this, FlowerDocs GUI includes a reverse proxy module based on Netflix’s Zuul open source product. A plugin is exposed under the /plugins/ path according to the routes defined.
A GUI plugin is configured using two types of information:
- The path of the requests to be intercepted (
Path) - The URL to which intercepted requests are redirected (
URL)
To access a route defined by a plugin, the client must be authenticated to the GUI.
Defining a plugin
A GUI plugin can be configured for a specific scope or for all the scopes of a FlowerDocs instance.
Scope-specific plugin
A plugin can be configured through a Route class document with Path and URL tags.
The configuration of these plugins is described in the Administration > Configuration > Plugins section of the administration console.
By defining a plugin with the /my-route/** path and the https://flowerdocs.com/my-plugin pour le scope <scope>, la requête exécutée sur /plugins/<scope>/my-route/test est redirigée vers https://flowerdocs.com/my-plugin/test URL.
Global plugin
A global plugin can be accessed from any scope. It must be configured through the gui.properties property file.
To define a new global plugin, it is necessary to define the corresponding route as:
zuul.routes.<plugin-id>.path=<plugin path>
zuul.routes.<plugin-id>.url=<external plugin URL>Example: Defining a plugin named myplugin
zuul.routes.myplugin.path=/plugins/sample/**
zuul.routes.myplugin.url=http://localhost:3006/sampleWith this example, requests issued on <gui>/plugins/sample are redirected to http://localhost:3006/sample.
The timeout on plugins can be configured using the zuul.host.connect-timeout-millis and zuul.host.socket-timeout-millis properties.
Default plugins
By default, several plugins are added to consume FlowerDocs resources. They are listed in the table below.
| Path | Target URL | Description |
|---|---|---|
/plugins/plume |
${gui.client.plume.url} |
Redirects to plume |
/plugins/soap |
${core}/services |
Redirects to SOAP services exposed by FlowerDocs Core |
/plugins/rest |
${core}/rest |
Redirects to REST services exposed by FlowerDocs Core |
/plugins/reporting |
${core}/external/reporting |
Redirects to the Kibana module of FlowerDocs Core |
/plugins/external |
${core}/external |
Redirects to plugins exposed by FlowerDocs Core |
Security
To access a plugin via FlowerDocs GUI, the client making the request must be authenticated (via the SESSIONcookie). This authentication is transmitted to the plugin in the form of an HTTP header token whose value is the token of the user making the request.
With the Spring MVC framework, this token can be retrieved by adding the following parameter to the input method: @RequestHeader("token") String token.