To configure the add-on you will find the link in the administration navigation "INTERGATOR Configuration"
Configuration
Use the settings screen to setup the connection between Confluence and your INTERGATOR server.
Add the right of the screen you will already see the INTERGATOR search and can validate that your settings are correct.
Settings
Setting | Description |
---|---|
Proxy Url (required) | URL used for proxy request to your INTERGATOR server. |
Public URL | Optional URL to render direct links to INTERGATOR. Proxy URL will be used as fallback. |
Facets | You have to configure all search facets users will be able to use. Please contact you INTERGATOR administrator for a list of all facets. |
SSL | Check, if your INTERGATOR server is using any kind of invalid SSL certificate. |
Anonymous access | Check to allow searches for anonymous users |
Link to INTERGATOR | Check to show INTERGATOR links for anonymous users as well. |
Anonymous user | Searches from anonymous users will be done on behalf of this user. |
Authentication |
|
PREAUTH Header | HTTP header which is used for PREAUTH authentication and used to send the username. |
Basic Auth Username | Username for Basic Auth authentication |
Basic Auth Password | Password for Basic Auth Authentication |
Cache | Activate local caching for thumbnails of search results |
Cache Expiration | Determine how long (in milliseconds) thumbnails are cached in local home directory. Default of 86400000 milliseconds corresponds to 24 hours. |
Replace Quick Search | Activate to open INTERGATOR embedded search instead of quick search. |
Placeholder | Specify the placeholder that appears in the search field. Default is "*" |
Extended Search Parameters
Configure the extended search parameters for request to the INTERGATOR.
Parameter | Description |
---|---|
Lenient | Check if requests should be lenient. |
Synonyms | Optional URL to render direct links to INTERGATOR. Proxy URL will be used as fallback. |
Stemming | You have to configure all search facets users will be able to use. Please contact you INTERGATOR administrator for a list of all facets. |
Check, if your INTERGATOR server is using any kind of invalid SSL certificate. | |
Anonymous access | Check to allow searches for anonymous users |
Enable PREAUTH authentication on INTERGATOR Server
We highly recommend using PREAUTH as authentication method for intergator in production usage. This is the only method, the search is done on behalf of the authenticated Confluence user.
To be able to use PREAUTH yourINTERGATOR server has to be configured supporting PREAUTH.
Please contact your INTERGATOR administrator or interface projects for configuring PREAUTH.
fas fa-info Go to INTERGATOR support
Embedded Search
The embedded search dialog similar to the Confluence quick search. If activated of in addon configuration search field in header instead of the quick search of Confluence will be shown.
Custom usage of embedded search
To open embedded search in your theme or environment you can dispatch the "moewe.addons.intergator:embedded-search" event with default query to open embedded search from everywhere.
window.dispatchEvent(new CustomEvent("moewe.addons.intergator:embedded-search", { detail: { query: "*" // or default query when embedded search opens } }));
To add custom javascript you will find here more information under this link (How to use JavaScript in Confluence).