Merge pull request #37 from SciCatProject/added-Elasticsearch-docs-fi…

…rst-draft

add: Elasticsearch docs first draft

Development/v4.x/backend/configuration.md

@@ -13,48 +13,47 @@ The list is compiled according to the configuration class defined in _src/config
 - ADMIN\_GROUPS:  
   list of groups that have admin priviliges  
   _default_: ""  
-  _format_: comma separated list of strings. Leading and trailing spaces are trimmed
+  _format_: comma separated list of strings. Leading and trailing spaces are trimmed  
 
 - DELETE\_GROUPS:  
   list of groups that are allowed to delete content  
   _default_: ""  
-  _format_: comma separated list of strings. Leading and trailing spaces are trimmed
+  _format_: comma separated list of strings. Leading and trailing spaces are trimmed  
 
 - CREATE\_DATASET\_GROUPS:  
-  list of non admin groups that are allowed to create datasets without pid. The pid is assigned by the system. If set to "all", all users can create a dataset belonging to any of the groups they belong to.  
+  list of non admin groups that are allowed to create datasets without pid. The pid is assigned by the system. If set to "all", all users can create a dataset belonging to any of the groups they belong to.    
   _default_: "#all"  
-  _format_: comma separated list of strings. Leading and trailing spaces are trimmed
+  _format_: comma separated list of strings. Leading and trailing spaces are trimmed  
 
 - CREATE\_DATASET\_WITH\_PID\_GROUPS:  
-  list of non admin groups that are allowed to create datasets with explicit pid. If set to "#all", all users can create a dataset belonging to any of the groups they belong to and with esplicit pid.
+  list of non admin groups that are allowed to create datasets with explicit pid. If set to "#all", all users can create a dataset belonging to any of the groups they belong to and with esplicit pid.  
   If the pid verification is enabled, pid will be validated agains the specification passed.  
   _default_: ""  
-  _format_: comma separated list of strings. Leading and trailing spaces are trimmed
+  _format_: comma separated list of strings. Leading and trailing spaces are trimmed  
 
 - CREATE\_DATASET\_PRIVILEGED\_GROUPS:  
-  list of non admin groups that are allowed to create datasets for groups they do not belong to. If set to "#all", all users can create a dataset belonging to any group with explicit pid.
+  list of non admin groups that are allowed to create datasets for groups they do not belong to. If set to "#all", all users can create a dataset belonging to any group with explicit pid.  
   If the pid verification is enabled, pid will be validated agains the specification passed.  
   _default_: ""  
-  _format_: comma separated list of strings. Leading and trailing spaces are trimmed 
+  _format_: comma separated list of strings. Leading and trailing spaces are trimmed  
 
 - ACCESS\_GROUPS\_STATIC\_VALUES:  
-  List of groups assigned by default to all users. Used in the vanilla implementation for easy configuration.   
+  List of groups assigned by default to all users. Used in the vanilla implementation for easy configuration.  
   If you do not want or need to assign any default group, it should be set to empty string "".  
   Default value: ""  
-  _format_: Comman separated list of strings.  Leading and trailing spaces are trimmed  
+  _format_: Comman separated list of strings. Leading and trailing spaces are trimmed  
   _example_: "group1,group2,group3,..."  
 
 - ACCESS\_GROUP\_SERVICE\_TOKEN:
-  Access token needed to access the API specified in ACCESS_GROUP_SERVICE_API_URL, used to
-  retrieve access groups from a third party system.    
-  _format_: string  
+  Access token needed to access the API specified in ACCESS\_GROUP\_SERVICE\_API\_URL, used to retrieve access groups from a third party system.  
+  _format*: string 
 
 - ACCESS\_GROUP\_SERVICE\_API\_URL:  
   Well formed url of the service API used to provide access groups. Only one value is allowed.  
-  _format_: string   
-  _example_: "https://my.access.group/service/api/url"   
+  _format_: string  
+  _example_: "https://my.access.group/service/api/url"
 
-- DOI\_PREFIX:   
+- DOI_PREFIX:  
   The facility DOI prefix, with trailing slash.  
   _default_: ""  
   _format_: string  
@@ -77,17 +76,17 @@ The list is compiled according to the configuration class defined in _src/config
 - HTTP\_TIMEOUT:  
   Timeout from http requests in ms.  
   _default_: 5000  
-  _format_: integer    
+  _format_: integer
 
-- JWT\_SECRET:  
+- JWT_SECRET:  
   The secret used to create any JWT token, used for authorization.  
-  _default_: ""   
-  _format_: string    
+  _default_: ""  
+  _format_: string  
 
 - JWT\_EXPIRES\_IN:  
   Expiration time of any JWT token in seconds.  
-  _default_: 3600 (s)   
-  _format_: integer   
+  _default_: 3600 (s)  
+  _format_: integer  
 
 - JWT\_NEVER\_EXPIRES:  
   Length of time that the never expiring jwt token will last.  
@@ -97,8 +96,8 @@ The list is compiled according to the configuration class defined in _src/config
 - LDAP\_URL:  
   Full URI (including port) of your local LDAP server, if this is your selected authentication method.  
   _default_: No default  
-  _example_: ldaps://ldap.server.com:636/  
-  _format_: string   
+  _example_: ldaps://ldap.server.com:636/   
+  _format_: string  
 
 - LDAP\_BIND\_DN:  
   Bind DN to access information on your LDAP server.  
@@ -112,18 +111,18 @@ The list is compiled according to the configuration class defined in _src/config
 
 - LDAP\_SEARCH\_BASE:  
   Search base for your LDAP server.  
-  _default_: No default  
+  _default_: No default   
   _format_: string  
 
 - LDAP\_SEARCH\_FILTER:  
   Search filter for you LDAP server.  
   _default_: No default  
-  _format_: string  
+  _format_: string   
   _example_: "(LDAPUsername={{username}})"  
 
 - LDAP\_MODE:  
   type of ldap server we are communicating with  
-  ___NEEDS TO BE UPDATED. Not sure which other values are accepted___
+  **_NEEDS TO BE UPDATED. Not sure which other values are accepted_**  
   _default_: ad  
   _format_: string  
   _acceptable values_: ad  
@@ -150,23 +149,23 @@ The list is compiled according to the configuration class defined in _src/config
   _format_: string  
   _example_: "scicat"  
 
-- OIDC\_CLIENT\_SECRET:  
+- OIDC\_CLIENT\_SECRET:   
   Token used to convert OIDC code to OIDC token. This is assigned in the OIDC service when the token is generated  
   _example_: "90f1268..."  
 
 - OIDC\_CALLBACK\_URL:  
-  URL of the endpoint that is called when the authentication has been executed with the OIDC service.  
-  _default_: No default  
-  _format_: string  
+  URL of the endpoint that is called when the authentication has been executed with the OIDC service.   
+  _default_: No default   
+  _format_: string    
   _example_: "http://localhost:3000/api/v3/oidc/callback"  
 
 - OIDC\_SCOPE:  
   Information returned by the OIDC service together with token  
   _default_: No default  
-  _format_: string  
+  _format_: string   
   _example_: "openid profile email"  
 
-- OIDC\_SUCCESS\_URL:   
+- OIDC\_SUCCESS\_URL:  
   Frontend URL that the user is directed to after a successful authentication. It must be a valid frontend URL.  
   _default_: No default  
   _format_: string  
@@ -196,12 +195,12 @@ The list is compiled according to the configuration class defined in _src/config
 - LOGBOOK\_ENABLED:  
   Flag to enable/disable the Logbook endpoints.  
   accept values: "yes", "no"  
-  _default_: no  
+  _default_: no   
   _format_: string  
 
 - LOGBOOK\_BASE\_URL:  
   The base URL to the SciChat wrapper API. Only required if Logbook is enabled.  
-  _default_: "http://localhost:3030/scichatapi"    
+  _default_: "http://localhost:3030/scichatapi"  
   _format_: string  
 
 - LOGBOOK\_USERNAME:  
@@ -210,8 +209,8 @@ The list is compiled according to the configuration class defined in _src/config
   _format_: string  
 
 - LOGBOOK\_PASSWORD:  
-  The password used to authenticate to the SciChat wrapper API. Only required if Logbook is enabled.    
-  _default_: No default   
+  The password used to authenticate to the SciChat wrapper API. Only required if Logbook is enabled.  
+  _default_: No default  
   _format_: string  
 
 - METADATA\_KEYS\_RETURN\_LIMIT:  
@@ -234,12 +233,12 @@ The list is compiled according to the configuration class defined in _src/config
   _default_: no default  
   _format_: string  
 
-- PID\_PREFIX:   
+- PID\_PREFIX:  
   The facility PID prefix, with trailing slash.  
   _default_: no default  
   _format_: string  
 
-- PUBLIC\_URL\_PREFIX:   
+- PUBLIC\_URL\_PREFIX:  
   The base URL to the facility Landing Page.  
   _default_: No default  
   _format_: string  
@@ -270,8 +269,8 @@ The list is compiled according to the configuration class defined in _src/config
   _format_: string  
 
 - RABBITMQ\_PASSWORD:  
-  The password used to authenticate to the RabbitMQ message broker. Only required if RabbitMQ is 
-  enabled.   
+  The password used to authenticate to the RabbitMQ message broker. Only required if RabbitMQ is
+  enabled.  
   _deprecated_. Will be removed in future releases.  
   _default_: no default  
   _format_: string  
@@ -298,15 +297,15 @@ The list is compiled according to the configuration class defined in _src/config
   _default_: no default  
   _format_: string  
 
-- SITE:    
+- SITE:  
   The name of your site.  
   _default_: no default  
   _format_: string  
 
 - SMTP\_HOST:  
-  Host of SMTP server.   
+  Host of SMTP server.  
   _deprecated_. Will be removed in future releases.  
-  _default_: no default    
+  _default_: no default  
   _format_: string  
 
 - SMTP\_MESSAGE\_FROM:  
@@ -333,6 +332,54 @@ The list is compiled according to the configuration class defined in _src/config
   _format_: integer  
 
 - POLICY\_RETENTION\_SHIFT:  
-  Number of years that the datasets are kept online before are archived or deleted. A negative value means that they are never archived/deleted   
+  Number of years that the datasets are kept online before are archived or deleted. A negative value means that they are never archived/deleted  
   _default_: -1  
   _format_: integer  
+
+- ELASTICSEARCH\_ENABLED:  
+  Flag to enable/disable the ElasticSearch service  
+  accept values: "yes", "no"  
+  _default_: no default  
+  _format_: string  
+
+- ES\_HOST:  
+  The base URL to the Elasticsearch cluster. Use `http` if xpack.security is disabled  
+  _default_: no default  
+  _format_: string   
+  _example_: "https://localhost:9200" or "http://localhost:9200"  
+
+- MONGODB\_COLLECTION:  
+  Collection name to be mapped into specified Elasticsearch index  
+  _default_: no default  
+  _format_: string  
+
+- ES\_MAX\_RESULT:   
+  Maximum records can be indexed into Elasticsearch.  
+  _default_: 10000  
+  _format_: number  
+
+- ES\_FIELDS\_LIMIT:   
+  The total number of fields in an index.  
+  _default_: 1000  
+  _format_: number  
+
+- ES\_INDEX:  
+  The total number of fields in an index.  
+  _default_: no default  
+  _format_: string  
+
+- ES\_REFRESH:  
+  The total number of fields in an index.  
+  accept values: true, false, "wait_for"  
+  _default_: false  
+  _format_: boolean or string  
+
+- ES\_USERNAME:  
+  Elasticsearch cluster username.  
+  _default_: no default, optional.  
+  _format_: string  
+
+- ELASTIC\_PASSWORD:   
+  Elasticsearch cluster password.  
+  _default_: no default.  
+  _format_: string