Configure App settings
The appsettings.json file defines server specific settings.
Api2File is shipped with sensible defaults, so it is not necessary to alter the values of the appsettings.json file. However, tweaking the values in the file may allow performance to be optimised for certain edge use-cases.
server
Fixed Fields:
| Property Name | Type | Description |
|---|---|---|
| port | number | REQUIRED. Specifies the port to serve the UNC shares on. The built-in Windows smb client use 445 and are not configurable. Only use a different value for port if your clients support connecting to custom ports. |
| smb1 | boolean | REQUIRED. Enables SMB1 clients. It is RECOMMENDED to NOT enable SMB1 clients due to security risks with the SMB1 protocol. |
| smb2 | boolean | REQUIRED. Enables SMB2 clients. |
| smb3 | boolean | REQUIRED. Enables SMB3 clients. |
apiReader
Fixed Fields:
| Property Name | Type | Description |
|---|---|---|
| bufferBytes | number | Specifies the size of data buffers used before streaming data to UNC clients. |
cache
Fixed Fields:
| Property Name | Type | Description |
|---|---|---|
| diskCacheThreshold | number | Specifies the file size, in bytes, where Api2File caches the data on disk rather than in memory. Caching to disk can impact of data retrieval for frequently accessed files, therefore clients will receive the best experience if most files are served from system memory. |
configuration
Fixed Fields:
| Property Name | Type | Description |
|---|---|---|
| api | string | REQUIRED. Specifies the the path (and name) of the apis.yaml file. |
| licenses | string | REQUIRED. Specifies the the path of the directory where license files are stored. |
desktop.ini
Fixed Fields:
| Property Name | Type | Description |
|---|---|---|
| enabled | boolean | Specifies if Api2File delivers a desktop.ini file for UNC shares. Desktop.ini is a windows settings file that allows visual customisation of network directories. Enabling this setting does not impact the functionality of Api2File or the data delivery. |
| licenses | string | REQUIRED. Specifies the the path of the directory where license files are stored.. |
audit
Fixed Fields:
| Property Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| file | string | Structure that defines attributes of auditing to file. Fixed Fields:
| ||||||||||||
| excludeDirectoryAccess | boolean | Specifies if Api2File audits directory access as well as file access. | ||||||||||||
| excludeFiles | [string] | Specifies a list of file names to exclude from auditing. Defaults to some common file names that are requested by-default by windows or file utilities. |