Service Configuration

Example YAML Config

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54


# Autogenerated
# Filename: search-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9224
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9220
  tls: null
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
grpc_client_tls: null
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  async_uploads: true
  num_consumers: 0
  debounce_duration: 1000
  tls_insecure: false
  tls_root_ca_certificate: ""
  enable_tls: false
  username: ""
  password: ""
engine:
  type: bleve
  bleve:
    data_path: /var/lib/ocis/search
extractor:
  type: basic
  cs3_allow_insecure: false
  tika:
    tika_url: http://127.0.0.1:9998
    clean_stop_words: true
content_extraction_size_limit: 20971520
service_account:
  service_account_id: ""
  service_account_secret: ""

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED SEARCH_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE SEARCH_TRACING_TYPE	string		The type of tracing. Defaults to ‘’, which is the same as ‘jaeger’. Allowed tracing types are ‘jaeger’ and ’’ as of now.
OCIS_TRACING_ENDPOINT SEARCH_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR SEARCH_TRACING_COLLECTOR	string		The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.
OCIS_LOG_LEVEL SEARCH_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY SEARCH_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR SEARCH_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE SEARCH_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
SEARCH_DEBUG_ADDR	string	127.0.0.1:9224	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
SEARCH_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
SEARCH_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
SEARCH_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
SEARCH_GRPC_ADDR	string	127.0.0.1:9220	The bind address of the GRPC service.
OCIS_JWT_SECRET SEARCH_JWT_SECRET	string		The secret to mint and validate jwt tokens.
OCIS_REVA_GATEWAY	string	com.owncloud.api.gateway	The CS3 gateway endpoint.
OCIS_GRPC_CLIENT_TLS_MODE	string		TLS mode for grpc connection to the go-micro based grpc services. Possible values are ‘off’, ‘insecure’ and ‘on’. ‘off’: disables transport security for the clients. ‘insecure’ allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). ‘on’ enables transport security, including server certificate verification.
OCIS_GRPC_CLIENT_TLS_CACERT	string		Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.
OCIS_EVENTS_ENDPOINT SEARCH_EVENTS_ENDPOINT	string	127.0.0.1:9233	The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
OCIS_EVENTS_CLUSTER SEARCH_EVENTS_CLUSTER	string	ocis-cluster	The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system.
OCIS_ASYNC_UPLOADS SEARCH_EVENTS_ASYNC_UPLOADS	bool	true	Enable asynchronous file uploads.
SEARCH_EVENTS_NUM_CONSUMERS	int	0	The amount of concurrent event consumers to start. Event consumers are used for searching files. Multiple consumers increase parallelisation, but will also increase CPU and memory demands. The default value is 0.
SEARCH_EVENTS_REINDEX_DEBOUNCE_DURATION	int	1000	The duration in milliseconds the reindex debouncer waits before triggering a reindex of a space that was modified.
OCIS_INSECURE SEARCH_EVENTS_TLS_INSECURE	bool	false	Whether to verify the server TLS certificates.
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE	string		The root CA certificate used to validate the server’s TLS certificate. If provided SEARCH_EVENTS_TLS_INSECURE will be seen as false.
OCIS_EVENTS_ENABLE_TLS SEARCH_EVENTS_ENABLE_TLS	bool	false	Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_EVENTS_AUTH_USERNAME SEARCH_EVENTS_AUTH_USERNAME	string		The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_EVENTS_AUTH_PASSWORD SEARCH_EVENTS_AUTH_PASSWORD	string		The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services.
SEARCH_ENGINE_TYPE	string	bleve	Defines which search engine to use. Defaults to ‘bleve’. Supported values are: ‘bleve’.
SEARCH_ENGINE_BLEVE_DATA_PATH	string	/var/lib/ocis/search	The directory where the filesystem will store search data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/search.
SEARCH_EXTRACTOR_TYPE	string	basic	Defines the content extraction engine. Defaults to ‘basic’. Supported values are: ‘basic’ and ’tika’.
OCIS_INSECURE SEARCH_EXTRACTOR_CS3SOURCE_INSECURE	bool	false	Ignore untrusted SSL certificates when connecting to the CS3 source.
SEARCH_EXTRACTOR_TIKA_TIKA_URL	string	http://127.0.0.1:9998	URL of the tika server.
SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS	bool	true	Defines if stop words should be cleaned or not. See the documentation for more details.
SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT	uint64	20971520	Maximum file size in bytes that is allowed for content extraction.
OCIS_SERVICE_ACCOUNT_ID SEARCH_SERVICE_ACCOUNT_ID	string		The ID of the service account the service should use. See the ‘auth-service’ service description for more details.
OCIS_SERVICE_ACCOUNT_SECRET SEARCH_SERVICE_ACCOUNT_SECRET	string		The service account secret.