Zum Hauptinhalt springen
Version: rolling

Environment Variables

Environment variables for the search service

NameIntroduction VersionTypeDescriptionDefault Value
OC_LOG_LEVEL
SEARCH_LOG_LEVEL
1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'."error"
SEARCH_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed."127.0.0.1:9224"
SEARCH_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint.""
SEARCH_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profiling."false"
SEARCH_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces."false"
SEARCH_GRPC_DISABLED4.0.0boolDisables the GRPC service. Set this to true if the service should only handle events."false"
SEARCH_GRPC_ADDR1.0.0stringThe bind address of the GRPC service."127.0.0.1:9220"
OC_JWT_SECRET
SEARCH_JWT_SECRET
1.0.0stringThe secret to mint and validate jwt tokens.""
OC_REVA_GATEWAY1.0.0stringThe CS3 gateway endpoint."eu.opencloud.api.gateway"
OC_GRPC_CLIENT_TLS_MODE1.0.0stringTLS 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_CACERT1.0.0stringPath/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.""
SEARCH_EVENTS_DISABLED4.0.0boolDisables listening for events. Set this to true if the service should only handle GRPC requests."false"
OC_EVENTS_ENDPOINT
SEARCH_EVENTS_ENDPOINT
1.0.0stringThe 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_CLUSTER
SEARCH_EVENTS_CLUSTER
1.0.0stringThe 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_UPLOADS
SEARCH_EVENTS_ASYNC_UPLOADS
1.0.0boolEnable asynchronous file uploads."true"
SEARCH_EVENTS_NUM_CONSUMERS1.0.0intThe 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."1"
SEARCH_EVENTS_REINDEX_DEBOUNCE_DURATION1.0.0intThe duration in milliseconds the reindex debouncer waits before triggering a reindex of a space that was modified."1000"
OC_INSECURE
OC_EVENTS_TLS_INSECURE
SEARCH_EVENTS_TLS_INSECURE
1.0.0boolWhether to verify the server TLS certificates."false"
OC_EVENTS_TLS_ROOT_CA_CERTIFICATE
SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE
1.0.0stringThe 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_TLS
SEARCH_EVENTS_ENABLE_TLS
1.0.0boolEnable 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_USERNAME
SEARCH_EVENTS_AUTH_USERNAME
1.0.0stringThe 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_PASSWORD
SEARCH_EVENTS_AUTH_PASSWORD
1.0.0stringThe password to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.""
SEARCH_EVENTS_MAX_ACK_PENDING4.0.0intThe maximum number of unacknowledged messages. This is used to limit the number of messages that can be in flight at the same time."1000"
SEARCH_EVENTS_ACK_WAIT4.0.0DurationThe time to wait for an ack before the message is redelivered. This is used to ensure that messages are not lost if the consumer crashes."1m0s"
SEARCH_ENGINE_TYPE1.0.0stringDefines which search engine to use. Defaults to 'bleve'. Supported values are: 'bleve'."bleve"
SEARCH_ENGINE_BLEVE_DATA_PATH1.0.0stringThe directory where the filesystem will store search data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/search."/var/lib/opencloud/search"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_ADDRESSES4.0.0[]stringThe addresses of the OpenSearch nodes.."[]"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_USERNAME4.0.0stringUsername for HTTP Basic Authentication.""
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_PASSWORD4.0.0stringPassword for HTTP Basic Authentication.""
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_HEADER4.0.0HeaderHTTP headers to include in requests."map[]"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_CA_CERT4.0.0stringPath/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the opensearch server.""
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_RETRY_ON_STATUS4.0.0[]intHTTP status codes that trigger a retry."[]"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_DISABLE_RETRY4.0.0boolDisable retries on errors."false"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_ENABLE_RETRY_ON_TIMEOUT4.0.0boolEnable retries on timeout."false"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_MAX_RETRIES4.0.0intMaximum number of retries for requests."0"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_COMPRESS_REQUEST_BODY4.0.0boolCompress request bodies."false"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_DISCOVER_NODES_ON_START4.0.0boolDiscover nodes on service start."false"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_DISCOVER_NODES_INTERVAL4.0.0DurationInterval for discovering nodes."0s"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_ENABLE_METRICS4.0.0boolEnable metrics collection."false"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_ENABLE_DEBUG_LOGGER4.0.0boolEnable debug logging."false"
SEARCH_ENGINE_OPEN_SEARCH_CLIENT_INSECURE4.0.0boolSkip TLS certificate verification."false"
SEARCH_ENGINE_OPEN_SEARCH_RESOURCE_INDEX_NAME4.0.0stringThe name of the OpenSearch index for resources."opencloud-resource"
SEARCH_EXTRACTOR_TYPE1.0.0stringDefines the content extraction engine. Defaults to 'basic'. Supported values are: 'basic' and 'tika'."basic"
OC_INSECURE
SEARCH_EXTRACTOR_CS3SOURCE_INSECURE
1.0.0boolIgnore untrusted SSL certificates when connecting to the CS3 source."false"
SEARCH_EXTRACTOR_TIKA_TIKA_URL1.0.0stringURL of the tika server."http://127.0.0.1:9998"
SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS1.0.0boolDefines if stop words should be cleaned or not. See the documentation for more details."false"
SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT1.0.0uint64Maximum file size in bytes that is allowed for content extraction."20971520"
SEARCH_BATCH_SIZE1.0.0intThe number of documents to process in a single batch. Defaults to 500."50"
OC_SERVICE_ACCOUNT_ID
SEARCH_SERVICE_ACCOUNT_ID
1.0.0stringThe ID of the service account the service should use. See the 'auth-service' service description for more details.""
OC_SERVICE_ACCOUNT_SECRET
SEARCH_SERVICE_ACCOUNT_SECRET
1.0.0stringThe service account secret.""