Environment Variables
Environment variables for the search service
| Name | Introduction Version | Type | Description | Default Value |
|---|---|---|---|---|
OC_TRACING_ENABLEDSEARCH_TRACING_ENABLED | 1.0.0 | bool | Activates tracing. | false |
OC_TRACING_TYPESEARCH_TRACING_TYPE | 1.0.0 | string | The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. | |
OC_TRACING_ENDPOINTSEARCH_TRACING_ENDPOINT | 1.0.0 | string | The endpoint of the tracing agent. | |
OC_TRACING_COLLECTORSEARCH_TRACING_COLLECTOR | 1.0.0 | 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. | |
OC_LOG_LEVELSEARCH_LOG_LEVEL | 1.0.0 | string | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | |
OC_LOG_PRETTYSEARCH_LOG_PRETTY | 1.0.0 | bool | Activates pretty log output. | false |
OC_LOG_COLORSEARCH_LOG_COLOR | 1.0.0 | bool | Activates colorized log output. | false |
OC_LOG_FILESEARCH_LOG_FILE | 1.0.0 | string | The path to the log file. Activates logging to this file if set. | |
SEARCH_DEBUG_ADDR | 1.0.0 | string | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | 127.0.0.1:9224 |
SEARCH_DEBUG_TOKEN | 1.0.0 | string | Token to secure the metrics endpoint. | |
SEARCH_DEBUG_PPROF | 1.0.0 | bool | Enables pprof, which can be used for profiling. | false |
SEARCH_DEBUG_ZPAGES | 1.0.0 | bool | Enables zpages, which can be used for collecting and viewing in-memory traces. | false |
SEARCH_GRPC_ADDR | 1.0.0 | string | The bind address of the GRPC service. | 127.0.0.1:9220 |
OC_JWT_SECRETSEARCH_JWT_SECRET | 1.0.0 | string | The secret to mint and validate jwt tokens. | |
OC_REVA_GATEWAY | 1.0.0 | string | The CS3 gateway endpoint. | eu.opencloud.api.gateway |
OC_GRPC_CLIENT_TLS_MODE | 1.0.0 | 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. | |
OC_GRPC_CLIENT_TLS_CACERT | 1.0.0 | 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. | |
OC_EVENTS_ENDPOINTSEARCH_EVENTS_ENDPOINT | 1.0.0 | string | The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. | 127.0.0.1:9233 |
OC_EVENTS_CLUSTERSEARCH_EVENTS_CLUSTER | 1.0.0 | string | 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. | opencloud-cluster |
OC_ASYNC_UPLOADSSEARCH_EVENTS_ASYNC_UPLOADS | 1.0.0 | bool | Enable asynchronous file uploads. | true |
SEARCH_EVENTS_NUM_CONSUMERS | 1.0.0 | int | 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. | 0 |
SEARCH_EVENTS_REINDEX_DEBOUNCE_DURATION | 1.0.0 | int | The duration in milliseconds the reindex debouncer waits before triggering a reindex of a space that was modified. | 1000 |
OC_INSECURESEARCH_EVENTS_TLS_INSECURE | 1.0.0 | bool | Whether to verify the server TLS certificates. | false |
OC_EVENTS_TLS_ROOT_CA_CERTIFICATESEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE | 1.0.0 | string | The root CA certificate used to validate the server's TLS certificate. If provided SEARCH_EVENTS_TLS_INSECURE will be seen as false. | |
OC_EVENTS_ENABLE_TLSSEARCH_EVENTS_ENABLE_TLS | 1.0.0 | bool | Enable TLS for the connection to the events broker. The events broker is the OpenCloud service which receives and delivers events between the services. | false |
OC_EVENTS_AUTH_USERNAMESEARCH_EVENTS_AUTH_USERNAME | 1.0.0 | string | The username to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services. | |
OC_EVENTS_AUTH_PASSWORDSEARCH_EVENTS_AUTH_PASSWORD | 1.0.0 | string | The password to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services. | |
SEARCH_ENGINE_TYPE | 1.0.0 | string | Defines which search engine to use. Defaults to 'bleve'. Supported values are: 'bleve'. | bleve |
SEARCH_ENGINE_BLEVE_DATA_PATH | 1.0.0 | string | The directory where the filesystem will store search data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/search. | /home/chaser/.opencloud/search |
SEARCH_EXTRACTOR_TYPE | 1.0.0 | string | Defines the content extraction engine. Defaults to 'basic'. Supported values are: 'basic' and 'tika'. | basic |
OC_INSECURESEARCH_EXTRACTOR_CS3SOURCE_INSECURE | 1.0.0 | bool | Ignore untrusted SSL certificates when connecting to the CS3 source. | false |
SEARCH_EXTRACTOR_TIKA_TIKA_URL | 1.0.0 | string | URL of the tika server. | http://127.0.0.1:9998 |
SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS | 1.0.0 | bool | Defines if stop words should be cleaned or not. See the documentation for more details. | true |
SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT | 1.0.0 | uint64 | Maximum file size in bytes that is allowed for content extraction. | 20971520 |
OC_SERVICE_ACCOUNT_IDSEARCH_SERVICE_ACCOUNT_ID | 1.0.0 | string | The ID of the service account the service should use. See the 'auth-service' service description for more details. | |
OC_SERVICE_ACCOUNT_SECRETSEARCH_SERVICE_ACCOUNT_SECRET | 1.0.0 | string | The service account secret. |