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


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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9255
  token: ""
  pprof: false
  zpages: false
store:
  store: nats-js-kv
  nodes:
  - 127.0.0.1:9233
  database: postprocessing
  table: ""
  ttl: 0s
  size: 0
  username: ""
  password: ""
postprocessing:
  events:
    endpoint: 127.0.0.1:9233
    cluster: ocis-cluster
    tls_insecure: false
    tls_root_ca_certificate: ""
    enable_tls: false
    username: ""
    password: ""
  steps: []
  delayprocessing: 0s
  retry_backoff_duration: 5s
  max_retries: 14

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED POSTPROCESSING_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE POSTPROCESSING_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 POSTPROCESSING_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR POSTPROCESSING_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 POSTPROCESSING_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY POSTPROCESSING_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR POSTPROCESSING_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE POSTPROCESSING_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
POSTPROCESSING_DEBUG_ADDR	string	127.0.0.1:9255	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
POSTPROCESSING_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
POSTPROCESSING_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
POSTPROCESSING_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
OCIS_PERSISTENT_STORE POSTPROCESSING_STORE	string	nats-js-kv	The type of the store. Supported values are: ‘memory’, ‘ocmem’, ’etcd’, ‘redis’, ‘redis-sentinel’, ’nats-js’, ’noop’. See the text description for details.
OCIS_PERSISTENT_STORE_NODES POSTPROCESSING_STORE_NODES	[]string	[127.0.0.1:9233]	A list of nodes to access the configured store. This has no effect when ‘memory’ or ‘ocmem’ stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.
POSTPROCESSING_STORE_DATABASE	string	postprocessing	The database name the configured store should use.
POSTPROCESSING_STORE_TABLE	string		The database table the store should use.
OCIS_PERSISTENT_STORE_TTL POSTPROCESSING_STORE_TTL	Duration	0s	Time to live for events in the store. See the Environment Variable Types description for more details.
OCIS_PERSISTENT_STORE_SIZE POSTPROCESSING_STORE_SIZE	int	0	The maximum quantity of items in the store. Only applies when store type ‘ocmem’ is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default.
OCIS_PERSISTENT_STORE_AUTH_USERNAME POSTPROCESSING_STORE_AUTH_USERNAME	string		The username to authenticate with the store. Only applies when store type ’nats-js-kv’ is configured.
OCIS_PERSISTENT_STORE_AUTH_PASSWORD POSTPROCESSING_STORE_AUTH_PASSWORD	string		The password to authenticate with the store. Only applies when store type ’nats-js-kv’ is configured.
OCIS_EVENTS_ENDPOINT POSTPROCESSING_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 POSTPROCESSING_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_INSECURE POSTPROCESSING_EVENTS_TLS_INSECURE	bool	false	Whether the ocis server should skip the client certificate verification during the TLS handshake.
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE POSTPROCESSING_EVENTS_TLS_ROOT_CA_CERTIFICATE	string		The root CA certificate used to validate the server’s TLS certificate. If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false.
OCIS_EVENTS_ENABLE_TLS POSTPROCESSING_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 POSTPROCESSING_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 POSTPROCESSING_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.
POSTPROCESSING_STEPS	[]string	[]	A list of postprocessing steps processed in order of their appearance. Currently supported values by the system are: ‘virusscan’, ‘policies’ and ‘delay’. Custom steps are allowed. See the documentation for instructions. See the Environment Variable Types description for more details.
POSTPROCESSING_DELAY	Duration	0s	After uploading a file but before making it available for download, a delay step can be added. Intended for developing purposes only. If a duration is set but the keyword ‘delay’ is not explicitely added to ‘POSTPROCESSING_STEPS’, the delay step will be processed as last step. In such a case, a log entry will be written on service startup to remind the admin about that situation. See the Environment Variable Types description for more details.
POSTPROCESSING_RETRY_BACKOFF_DURATION	Duration	5s	The base for the exponential backoff duration before retrying a failed postprocessing step. See the Environment Variable Types description for more details.
POSTPROCESSING_MAX_RETRIES	int	14	The maximum number of retries for a failed postprocessing step.