File Engine Configurations

Follow these steps to configure File Engine:

Stop EF_FileEngine service in Windows Services pane
Navigate to <installation-dir>\hybrid-chat\core\file_engine\
Open docker-variables.env file with any text editor
Save the file after configuration changes and start EF_FileEngine service in Windows Services pane
File Engine logs are generated at /EFLogs/chat-solution/file-engine/ directory

Configuration

Following table explains configuration parameters:

	Configuration Variable	Default Value	Expected Value	Description
1	MINIOPORT	9000	Number	Minio hosting port
2	ACCESSKEY	admin	String	Minio access key
3	SECRETKEY	admiN123!	String	Minio Secret key
4	ENDPOINT	localhost	String	Minio host address
5	USESSL	true	Boolean `true / false`	Host File Engine over HTTPS when `true`
6	USESSL_MINIO	false	Boolean `true / false`	Connect Minio over SSL when `true`
7	PORT	8495	Number	Port where File Engine is hosted
8	CERTIFICATE_AUTHORITY	https/file-engine.ca-bundle	String	File Engine certificate authority path
9	BUCKETNAME	default	String	Minio bucket name, File Engine creates this bucket on first startup
10	PRIVATEKEY	https/localhost.key	String	File Engine server certificate's private key path
11	CERTIFICATE	https/localhost.cert	String	File Engine server certificate path
12	PASSPHRASE	expertflow	String	File Engine server certificate passphrase
13	MAXFILESIZE	5	Number	Allowed max file size in Megabytes. Default is 5MB.
14	ALLOWEDFILETYPES	png,jpeg,jpg,pdf,ppt,doc,docx,xls,xlsx,txt	String	Allowed file extensions, to allow more extensions, add there extensions separated by comma as default value illustrates
15	CONTENTDISPOSITION	inline	String	Content Disposition for file downloading from File Engine. See more information about Content Disposition.
16	BLOCK_UNKNOWN_FILES	false	boolean
17	USE_FORWARD_PROXY	false
18	USE_SECURED_FORWARD_PROXY	false
19	FORWARD_PROXY_HOST	0.0.0.0
20	FORWARD_PROXY_PORT	8080
21	FORWARD_PROXY_USER	xxxx
22	FORWARD_PROXY_PASSWORD	xxxx
23	BYPASS_STRICT_TYPE_CHECK	false		If you want to allow for any script file to be uploaded to server, add that extension in ALLOWEDFILETYPES and set BYPASS_STRICT_TYPE_CHECK=true, other strict type checking will not let the script/code file pass through even if it is allowed in ALLOWEDFILETYPES
24	FILE_NAME		String	# FILE_NAME environment variable can be used to configure custom filename schemes # If FILE_NAME environment variable is not present or empty, default scheme will be used Default Scheme: # File Name in Minio S3 bucket: <conversation-id>_<original-file-name>.<extension> Where: # - <conversation-id> : conversation id for which file is being uploaded # - <original-file-name> : original file name while uploading # - <extension> : extension of file FILE_NAME can be configured using the following four variables: 1. {CONVERSATION_ID} : conversation id for which file is being uploaded 2. {UUID} : use it if you want to use GUID/UUID in file name 3. {ORIGINAL_NAME} : original file name while uploading 4. {EXT} : extension of file Examples: # FILE_NAME={CONVERSATION_ID}_{UUID}_{ORIGINAL_NAME}.{EXT} will produce a file name of <conversation-id>_<a-random-uuid>_<actual-file-name>.<extension> # FILE_NAME={UUID} will produce a file name of <a-random-uuid>. It will not have any extension but note that its mime type will remain original # The above mentioned examples are showing just two possibilities, you can add them in any format. # Spaces in file name will be replaced to -, for example: # FILE_NAME={UUID} {ORIGINAL_NAME} .{EXT} will yield : <a-random-uuid>---<original-file-name>---.<extension>
25