Server
This manual lists all the configurations that the S-Filer Portal's Configuration CLI can change about the Server.
| Configuration key | Description | Default value |
|---|---|---|
| cfg. | Maximum number of asynchronous tasks that will be reserved at any given time for each task runner (there is one runner for each concurrent task that can be executed). | 100 |
| cfg. | Number of asynchronous tasks that can be executed concurrently. | 10 |
| cfg. | Frequency (in seconds) at which the server verifies if there are pending asynchronous tasks that can be executed. | 300 |
| cfg. | Includes in the report the action done by S-Filer's extensions | true |
| cfg. | This is the time in second that a logged user can spend without interacting with the system. This value is for S-Filer Server. This value is use for any Sfiler Server client, Gateway, command line interface etc... When this time is reach, the user will have to log again in the System to be able to use it. | 1800 |
| cfg. | Delay in days between the notification and the actual certificate expiration. Set to -1 to indicate that no notification should be sent. (Default: -1) | -1 |
| cfg. | If you enable this property, S-Filer Portal Server will set values in the html header's metadata for X-Frame-Options and Content-Security-Policy | true |
| cfg. | Specifies the issuer of the cryptographic service. | S-Filer |
| cfg. | Defines the validity period for MFA long-lived tokens in hours. | 168 |
| cfg. | Specifies the validity period for cryptographic service tokens in seconds. | 86400 |
| cfg. | This indicates whether HSTS headers should be added in Server responses. When it is active, browsers will only connect to pages on the same sub-domain in HTTPS. Activate this unless other pages served under the same sub-domain are unsecured (HTTP instead of HTTPS). | true |
| cfg. | This indicates the time during which the browsers will remember to only use HTTPs for the Server responses (in seconds). Put in a small value at first such that if there is a mistake (or another site that is using HTTP and is not working), you can disable the HSTS and after some time, clients will be able to access the site in HTTP. If after initial deployment there are no errors, you can increase this value to a very long time. | 3600 |
| cfg. | Server host. | |
| cfg. | Turn on the German language | true |
| cfg. | Turn on the English language | true |
| cfg. | Turn on the Spanish language | true |
| cfg. | Turn on the French language | true |
| cfg. | Turn on the Italian language | true |
| cfg. | If set to "Yes", this configuration parameter will limit the verbosity of an authentication failure in the server logs. | true |
| cfg. | Log Level of S-Filer Server. When a problem occurs, the log file can be used to detect the problem cause. In normal operation, a Warning or Info Level is sufficient. When investigating a problem, use the Debug level to quickly and more deeply understand the cause. Leaving the Log level to DEBUG can decrease the system performance due to Disk access. | INFO |
| cfg. | Sender email address of the email notification system. | |
| cfg. | Name appearing as sender in email notification sent to users. | S-Filer Notification System |
| cfg. | Period of time (in minutes) during which the system will retry to send failed emails. After this period, the email is deleted without being sent. The frequency of the retries depends on the "Email Sender" schedule. | 2880 |
| cfg. | Address used when a scheduled event detects a problem with the system. | |
| cfg. | Language used when a scheduled event detects a problem with the system. | en |
| cfg. | Determines whether to use or not the basic authentication with the email server. | false |
| cfg. | Password used to access the email server. | |
| cfg. | User name used to access the email server. | |
| cfg. | This is the client identifier used to authenticate when retrieving an authentication token. For more details on this configuration, consult the SMTP OAuth2 article in the online documentation. | |
| cfg. | This is the client secret used to authenticate when retrieving an authentication token. For more details on this configuration, consult the SMTP OAuth2 article in the online documentation. | |
| cfg. | Determines whether to use or not the OAuth2 authentication with the email server. | false |
| cfg. | One or more scope values indicating to which resources access must be granted. For more details on this configuration, consult the SMTP OAuth2 article in the online documentation. | |
| cfg. | This URL is used to retrieve the authentication token that is needed to use the email server. For more details on this configuration, consult the SMTP OAuth2 article in the online documentation. | |
| cfg. | User name used to retrieve the authentication token. For more details on this configuration, consult the SMTP OAuth2 article in the online documentation. | |
| cfg. | IP address or Hostname of the email server. | |
| cfg. | Suffix of the files containing the body information. | _body.html |
| cfg. | Path to text files used to create email notification. | etc/mail/ |
| cfg. | File extension for files containing subject information. | _subject.html |
| cfg. | Port of the email server. Default: 25 (unsecure port), 465 (SSL port), 587 (STARTTLS port) | 25 |
| cfg. | Protocol used to send Email. | smtp |
| cfg. | Use a secure connection to the mail server. | false |
| cfg. | Connect on an unsecure port and then ask the server to negotiate a secure connection to the mail server, often referred to as STARTTLS. Some servers (e.g. GMAIL) require both SSL and STARTTLS to work. | false |
| cfg. | The email notification "theme" that will be used to notify users for which no specific "theme" is specified. | notification |
| cfg. | Number of milliseconds after which the S-Filer server will stop waiting for the email server if it has not responded. | 60000 |
| cfg. | This AND/OR value determines how "Quick Send" permissions from many groups are combined for a user. When set to AND, all groups must give the permission. When set to OR, at least one group must give the permission. | OR |
| cfg. | Maximum length allowed for the Community IDs. Validated by S-Filer Server. | 128 |
| cfg. | Maximum length allowed for the Community Description. Validated by S-Filer Server. | 128 |
| cfg. | This value is the number of days that a disabled user will remain in the S-Filer system. After this number of days, the user will be deleted. If this value is less than or equal to 0, the system will not delete any disabled users. | 180 |
| cfg. | This AND/OR value determines how "Download" permissions from many groups are combined for a user. When set to AND, all groups must give the permission. When set to OR, at least one group must give the permission. | OR |
| cfg. | Sets the maximum number of days a user can be inactive before being marked inactive. | 180 |
| cfg. | This AND/OR value determines how IP address restrictions from many groups are combined for a user. When set to AND, all groups must allow the IP address. When set to OR, at least one group must allow the IP address. | OR |
| cfg. | This AND/OR value determines how "Upload" permissions from many groups are combined for a user. When set to AND, all groups must give the permission. When set to OR, at least one group must give the permission. | OR |
| cfg. | Maximum length allowed for user Folder Alias. Validated by S-Filer Server. | 128 |
| cfg. | Maximum length allowed for user Email Address. Validated by S-Filer Server. | 128 |
| cfg. | Maximum length allowed for user full name. Validated by S-Filer Server. | 128 |
| cfg. | Maximum length allowed for Username. Validated by S-Filer Server. | 128 |
| cfg. | Maximum length allowed for Group Description. Validated by S-Filer Server. | 128 |
| cfg. | Maximum length allowed for Group IP field. Validated by S-Filer Server. | 128 |
| cfg. | Server port | |
| cfg. | HTTPS protocol can be used. | |
| cfg. | Path to the Audit Transfer Report source file. | report/AuditsReport.xml |
| cfg. | Path to the Audit Transfer Report source file in CSV format. | report/AuditsReport_csv.xml |
| cfg. | Path to the Community Report source file. | report/CommunitiesReport.jrxml |
| cfg. | Path to the Group Report source file. | report/GroupsReport.jrxml |
| cfg. | Path to the System Audit Report source file. | report/SystemEventAuditsReport.xml |
| cfg. | Path to the System Audit Report source file in CSV format. | report/SystemEventAuditsReport_csv.xml |
| cfg. | Path to the User Report source file. | report/UsersReport.jrxml |
| cfg. | Determines whether the report engine should include events from Extensions. | true |
| cfg. | Logo image file that will be displayed in the PDF report. | etc/images/logo.jpg |
| cfg. | Whether the assignGroupToCommunity REST API component is exposed. | false |
| cfg. | Whether the assignUserToCommunity REST API component is exposed. | false |
| cfg. | Whether the assignUserToGroup REST API component is exposed. | false |
| cfg. | Whether the assignUserToShareByEmail REST API component is exposed. | false |
| cfg. | Whether the assignUserToShareById REST API component is exposed. | false |
| cfg. | Whether the changePassword REST API component is exposed. | false |
| cfg. | Whether the completeTotpForUser REST API component is exposed. | false |
| cfg. | Whether the countTasks REST API component is exposed. | false |
| cfg. | Whether the createAccessTokenForUser REST API component is exposed. | false |
| cfg. | Whether the createCommunity REST API component is exposed. | false |
| cfg. | Whether the createGroup REST API component is exposed. | false |
| cfg. | Whether the createNotificationTheme REST API component is exposed. | false |
| cfg. | Whether the createShare REST API component is exposed. | false |
| cfg. | Whether the createTemplate REST API component is exposed. | false |
| cfg. | Whether the createTotpForUser REST API component is exposed. | false |
| cfg. | Whether the createUser REST API component is exposed. | false |
| cfg. | Whether the delete REST API component is exposed. | false |
| cfg. | Whether the deleteAccessTokenForUser REST API component is exposed. | false |
| cfg. | Whether the deleteAccessTokensForUser REST API component is exposed. | false |
| cfg. | Whether the deleteCommunity REST API component is exposed. | false |
| cfg. | Whether the deleteGroup REST API component is exposed. | false |
| cfg. | Whether the deleteNotificationTheme REST API component is exposed. | false |
| cfg. | Whether the deleteShare REST API component is exposed. | false |
| cfg. | Whether the deleteTemplate REST API component is exposed. | false |
| cfg. | Whether the deleteTotpForUser REST API component is exposed. | false |
| cfg. | Whether the deleteTotpsForUser REST API component is exposed. | false |
| cfg. | Whether the deleteUser REST API component is exposed. | false |
| cfg. | Whether the downloadFromFileVersionId REST API component is exposed. | false |
| cfg. | Whether the downloadFromNodeId REST API component is exposed. | false |
| cfg. | Whether the findAccessTokenForUser REST API component is exposed. | false |
| cfg. | Whether the findAccessTokensForUser REST API component is exposed. | false |
| cfg. | Whether the findCommunities REST API component is exposed. | false |
| cfg. | Whether the findCommunitiesForGroup REST API component is exposed. | false |
| cfg. | Whether the findCommunitiesForUser REST API component is exposed. | false |
| cfg. | Whether the findDomains REST API component is exposed. | false |
| cfg. | Whether the findGroups REST API component is exposed. | false |
| cfg. | Whether the findGroupsForCommunity REST API component is exposed. | false |
| cfg. | Whether the findGroupsForUser REST API component is exposed. | false |
| cfg. | Whether the findNotificationThemeContents REST API component is exposed. | false |
| cfg. | Whether the findNotificationThemes REST API component is exposed. | false |
| cfg. | Whether the findShareUsers REST API component is exposed. | false |
| cfg. | Whether the findStorages REST API component is exposed. | false |
| cfg. | Whether the findTemplates REST API component is exposed. | false |
| cfg. | Whether the findTotpForUser REST API component is exposed. | false |
| cfg. | Whether the findTotpsForUser REST API component is exposed. | false |
| cfg. | Whether the findUsers REST API component is exposed. | false |
| cfg. | Whether the findUsersForCommunity REST API component is exposed. | false |
| cfg. | Whether the findUsersForGroup REST API component is exposed. | false |
| cfg. | Whether the getCommunity REST API component is exposed. | false |
| cfg. | Whether the getFileInfoByNodeId REST API component is exposed. | false |
| cfg. | Whether the getFileVersionByFileVersionId REST API component is exposed. | false |
| cfg. | Whether the getGroup REST API component is exposed. | false |
| cfg. | Whether the getLicenseStats REST API component is exposed. | false |
| cfg. | Whether the getNotificationTheme REST API component is exposed. | false |
| cfg. | Whether the getNotificationThemeContent REST API component is exposed. | false |
| cfg. | Whether the getShare REST API component is exposed. | false |
| cfg. | Whether the getSystemCapabilities REST API component is exposed. | false |
| cfg. | Whether the getTaskByUuid REST API component is exposed. | false |
| cfg. | Whether the getTemplate REST API component is exposed. | false |
| cfg. | Whether the getTransferContextByUploadId REST API component is exposed. | false |
| cfg. | Whether the getTransferStats REST API component is exposed. | false |
| cfg. | Whether the getUser REST API component is exposed. | false |
| cfg. | Whether the list REST API component is exposed. | false |
| cfg. | Whether the lockUser REST API component is exposed. | false |
| cfg. | Whether the login REST API component is exposed. | false |
| cfg. | Whether the logout REST API component is exposed. | false |
| cfg. | Whether the mfaTotpValidateCode REST API component is exposed. | false |
| cfg. | Whether the mfaValidateLongLivedToken REST API component is exposed. | false |
| cfg. | Whether the mkdir REST API component is exposed. | false |
| cfg. | Whether the move REST API component is exposed. | false |
| cfg. | Whether the queryUsersByRemainingSpace REST API component is exposed. | false |
| cfg. | Whether the rename REST API component is exposed. | false |
| cfg. | Whether the resetUserPassword REST API component is exposed. | false |
| cfg. | Whether the resolve REST API component is exposed. | false |
| cfg. | Whether the takeShareOwnership REST API component is exposed. | false |
| cfg. | Whether the testNotification REST API component is exposed. | false |
| cfg. | Whether the transferShareOwnership REST API component is exposed. | false |
| cfg. | Whether the ttl REST API component is exposed. | false |
| cfg. | Whether the unassignGroupFromCommunity REST API component is exposed. | false |
| cfg. | Whether the unassignUserFromCommunity REST API component is exposed. | false |
| cfg. | Whether the unassignUserFromGroup REST API component is exposed. | false |
| cfg. | Whether the unassignUserFromShare REST API component is exposed. | false |
| cfg. | Whether the unlockUser REST API component is exposed. | false |
| cfg. | Whether the updateCommunity REST API component is exposed. | false |
| cfg. | Whether the updateGroup REST API component is exposed. | false |
| cfg. | Whether the updateNotificationTheme REST API component is exposed. | false |
| cfg. | Whether the updateNotificationThemeContent REST API component is exposed. | false |
| cfg. | Whether the updateShare REST API component is exposed. | false |
| cfg. | Whether the updateTemplate REST API component is exposed. | false |
| cfg. | Whether the updateUser REST API component is exposed. | false |
| cfg. | Whether the updateUserRoleInShare REST API component is exposed. | false |
| cfg. | Whether the uploadAnonymousHttpFile REST API component is exposed. | false |
| cfg. | Whether the uploadMembersHttpFile REST API component is exposed. | false |
| cfg. | Whether the uploadNodeHttpFile REST API component is exposed. | false |
| cfg. | Indicates whether the REST API exposition filter is active. | false |
| cfg. | Provides an override for the default description in the REST API exposition. | |
| cfg. | Provides an override for the default title in the REST API exposition. | |
| cfg. | Send an email notification when the integrity check has failed. The email notification is sent to the address specified in the Email section. | true |
| cfg. | Audit will be kept for X number of days | 365 |
| cfg. | If Yes entries will be archived to a file. If No, they will be deleted. | false |
| cfg. | Archives files will be prefixed with entered value. | archive |
| cfg. | Activate the System Event Audit. Select "YES" to log the system events. | true |
| cfg. | Archives files will be written in this folder. | / |
| cfg. | Maximum number of days that a file can be present in the server. Use a value equal to or less than 0 to specify an unlimited duration. | 730 |
| cfg. | This is the default value for the number of downloads allowed for "Quick Send" transfers. A value below or equal to 0 will result in an unlimited number of downloads. | 1 |
| cfg. | Number of days a Community must be inactive before it is automatically deleted. The inactive Community cleanup will be disabled if this value is less than or equal to 0. Note that downloading or uploading a file in a Community resets its inactivity period and that a Community with an expiration date will never be deleted due to its inactivity period. | -1 |
| cfg. | Notification email will be sent to the administrators of a Community that is within this number of days of being automatically deleted because of its expiration date or inactivity period. The email notification will be disabled if this value is less than or equal to 0. | 7 |
| cfg. | Specify the number of minutes to wait before deleting expired files. | 120 |
| cfg. | Maximum number of days that a pending upload will be available for resume. | 7 |
| cfg. | Maximum number of days that an inactive file will stay on the system. Use a value equal to or less than 0 to specify an unlimited duration. | 365 |
| cfg. | This option indicates whether a system administrator can exceed the absolute retention period when setting a community retention period. Usually, the absolute retention period can never be exceeded, but this allows an exception to this rule. | false |
| cfg. | Absolute maximum number days before sending a notice to owner. | -1 |
| cfg. | Maximum number days before sending a notice to owner. | -1 |
| cfg. | During cleanup, this value determines how much data to manage at once. | 1000 |
| cfg. | Whether to allow the REST API users to use the "Quick Send" feature. This feature enables sending files to a user using his email address. | true |
| cfg. | Whether to allow the REST API users to transfer files using HTTPS (without end-to-end encryption). Since end-to-end encryption is not supported by the REST API, all transfers will be forbidden if this feature is disabled. | true |
| cfg. | Whether to allow the REST API users to use the "Share file" feature. This feature enables users to create "shares" in which they can invite other users to participate using their email address. | false |
| cfg. | Number of days a Share must be inactive before it is automatically deleted. The inactive Share cleanup will be disabled if this value is less than or equal to 0. Note that downloading or uploading a file in a Share resets its inactivity period and that a Share with an expiration date will never be deleted due to its inactivity period. | 180 |
| cfg. | Notification email will be sent to the administrators of a Share that is within this number of days of being automatically deleted because of its expiration date or inactivity period. The email notification will be disabled if this value is less than or equal to 0. | 7 |
| cfg. | S-Filer performs many tasks on background threads including the post-processing of files after transfers. This setting dictates the maximum backlog (in seconds) for tasks. When the backlog exceeds this value, transfers will be throttled by refusing some of them until the backlog drops below this threshold. | 30 |
| cfg. | Session timeout of the internal Jetty server. | 30000 |
| cfg. | The key used to secure the HTTPS connection to the server. | |
| cfg. | Determines how SSL/TLS ciphers are managed. S-Filer maintains a list of strong ciphers that will evolve over time. The 'Automatic' mode allows to enable only the strong ciphers from this list. For some older clients, weaker ciphers may need to be enabled because they don't support any of the strong ones. The 'JVM Default' mode results in all ciphers present on the JVM to be enabled. For a more fine-grained control, the 'Custom' mode allows to specify all the ciphers that must be enabled in the 'Custom SSL/TLS ciphers' parameter. | AUTOMATIC |
| cfg. | List of SSL/TLS ciphers (separated by comma) that will be enabled if the cipher management mode is 'Custom'. WARNING: Some ciphers specified in this list may not be available depending on the key type of the SSL/TLS private key. | TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 |
| cfg. | Determines if the SSL/TLS SNI host check is enabled. SNI (Server Name Indication) is an extension to the SSL/TLS protocol by which a client indicates which hostname it is attempting to connect to at the start of the connection process. If the SNI host check is enabled and the hostname of the server to which the client is trying to connect to is not found in the server certificate, the server returns an invalid SNI error. | true |