All Syncplicity Customers who have StorageVaults either on-premises or in their own private cloud need upgrade to Storage Connector version 3.3x or later by July 1, 2021. See Checking Storage Connector version and our community post for detailed information.
This information provides an overview of the Storage Connector configuration settings. Some settings are required, others can be used to configure your Storage Connector instances environment and needs, or to assist in troubleshooting activities when advised by Syncplicity support.
The properties for all storage types have the following format: syncplicity.storage.<storage_type_name>.<bucket_name>.<property_name>
.
storage_type_name
can be any of the storage types that Syncplicity supportsbucket_name
is optional and can bedata
,image,
irm
orarchive
. Those as separated, asproperty_name
is the name of the specific property, for example,host
These properties are cascading, meaning that common values can be configured on the top level property (e.g. syncplicity.storage.atmos.url
) . That value will be used for the different storage sections (syncplicity.storage.atmos.data.url
), unless specified there.
If you do not specify a value in the bucket_name
subsection, Storage Connector uses a generic value syncplicity.storage.<storage_type_name>.<property_name>
for all storage properties that do not have a specified bucket.
If you specify a bucket name, the value of the property after the bucket name overrides the value of the generic property; the value used is syncplicity.storage.<storage type>.<bucket type>.<property_name>
.
Configuration for Storage Connector version 2.22.2 or older
The settings of Storage Connector 2.22.x are stored in file /etc/syncp-storage/syncp-storage.conf
. This file is written in HOCON format. See Using HOCON for reference.
To edit the file, type the following command in the console:
sudo vi /etc/syncp-storage/syncp-storage.conf
In this version, the config properties can be overridden. In the following config example the effective setting is the second (last) one.
|
Configuration for Storage Connector version 3.2.0 or newer
The settings of Storage Connector 3.2.x are stored in file /etc/syncp-storage/syncp-storage.yml
. This file is written in YAML format.
To edit the file, type the following command in the console:
sudo vi /etc/syncp-storage/syncp-storage.yml
In this version the properties cannot be overridden. Yaml file format does not allow duplicate entries.
Setting change history
Version 2.22.2
The default value for syncplicity.ws.corsexposeheaders
has been modified from Accusoft-Data-Encrypted, Accusoft-Data-SK, Syncplicity-Chunk-Size, Etag
to Accusoft-Data-Encrypted, Accusoft-Data-SK, Syncplicity-Chunk-Size, Etag, Range
.
Version 3.1.0
The default value of syncplicity.ws.corsheaders
has been modified: added Syncplicity-IRM-Config-Token
Version 3.2.0
A number of property names have been changed. See the table below for details. The following file types are deprecated: isilon
and vnx.
Version 3.2.3
New property added: syncplicity.security.obfuscateFilenames
. When enabled, names of the files will not appear in the Storage Connector logs.
Version 3.3.0
Added new properties for bulk download feature: syncplicity.storage.<storage_type_name>.archive.*
and syncplicity.bulkdownload.*
.
Version 3.3.1
New property added: syncplicity.storage.fs.fsTimeout
. For NFS storage types it enables you to modify the maximum wait time to read data from the mount point before returning an error.
List of configuration properties
The following table contains descriptions of the properties that you can modify. If the Required column for a property contains Y, the property is required and you must supply a value for it.
Column Setting in Version 3.2 contains only the names of the properties that were changed. The names of all other properties are the same as in version 2.22.2
Do not modify any properties in the syncp-storage.conf
file or the syncp-storage.yml
file that are not listed below unless you are explicitly instructed to do so by Syncplicity Support.
syncp-storage.yml
, they should be surrounded with double quotation marks ("). This is especially important when the value contains one of the following symbols: :-{}[]!#|>&%@
Common configuration
Setting in Version 3.2 and newer |
Setting in Version 2.22.2 (if different) |
Value Format |
Default Value |
Required |
Description |
---|---|---|---|---|---|
syncplicity.cleanup.objCount | syncplicity.cleanup.obj.count | integer | 250 | Y | Object count per request for objects to be cleaned up during the second phase of two-phase delete operation. The default value should be equal to the default value for cleanupBatchSize . |
syncplicity.concurrentSyncRequests.firstThreshold |
syncplicity.concurrent.syncrequests.firstthreshold |
integer |
95% of syncplicity.concurrentSyncRequests.limit |
N |
A threshold value for the throttling limit set in |
syncplicity.concurrentSyncRequests.limit |
syncplicity.concurrent.syncrequests.limit |
integer |
320 |
N |
Sets the limit on the number of concurrent requests. The Storage Connector applies a limit to the total number of concurrent requests it will process at any given time. This limit is commonly referred to as the throttling limit. This limit is available in the Storage Connector configuration file and can be set individually for each Storage Connector machine. See Best Practices - Storage Connector health metrics. |
syncplicity.crypto.compression | syncplicity.storage.compression | string | ZLIB | N | Sets the type of compression used for the storage endpoint. Valid values:BZIP2 ZIP ZLIB NONE |
syncplicity.crypto.encryption | syncplicity.storage.encryption | string | AES256 | N |
Sets the type of the encryption algorithm configured for the storage endpoint. Valid values: |
syncplicity.crypto.keyStore.enforced |
syncplicity.storage.keyStore.enforced | boolean | true | N | Determines whether secure credentials are enforced. If set to true , secure credentials are retrieved from the keystore. |
syncplicity.crypto.keyStore.file |
syncplicity.storage.keyStore.file | string | /etc/syncp-storage/keyStore.p12 | N | Sets the path to the keystore file. The path must be absolute, relative paths are not supported. |
syncplicity.crypto.keyStore.password |
syncplicity.storage.keyStore.password | string/hidden | N | When syncplicity.crypto.keyStore.enforced is false , this setting holds the keystore unlock password. |
|
syncplicity.crypto.keyStore.type |
syncplicity.storage.keyStore.type | string | PKCS12 | N | Sets the type of the keystore file. Valid values areJCEKS JKS DKS PKCS11 PKCS12 |
syncplicity.mail.host | smtp.host | string | Y | Sets the host name/IP address of SMTP gateway. For a configuration example, see Monitoring connectivity. | |
syncplicity.mail.port | smtp.port | integer | 25 | N | Sets the SMTP gateway port. For a configuration example, see Monitoring connectivity. |
syncplicity.mail.username | smtp.user | string | N | Sets the user name for acccessing the SMTP server. For a configuration example, see Monitoring connectivity. | |
syncplicity.mail.password | smtp.password | string | N | Sets the password for acccessing the SMTP server. For a configuration example, see Monitoring connectivity. | |
syncplicity.mail.ssl |
smtp.ssl | string | no | N |
Deprecated. Enables/disables SSL for SMTP sessions. For a configuration example, see Monitoring connectivity. Valid values are This property is deprecated as it is considered insecure. Please configure your SMTP server to use TLS ( |
syncplicity.mail.startTlsEnabled | smtp.tls | boolean | true | N | Enables/disables TLS for SMTP sessions. |
syncplicity.ws.url |
|
string |
https://xml.syncplicity.com/1.1 |
Y/N |
Sets the web services root URL. It is required if your account is not based in the US PrivacyRegion. For more information, see Configure the Storage Connector. |
syncplicity.ws.accesskey |
string/hidden |
Y |
Sets the web services access key used in order to identify the deployment. See Retrieve The Storagevault Access Key. |
||
syncplicity.ws.external.enabled |
boolean |
true |
N |
Enables/disables external web services gateway (API portal). See Configuring the Storage Connector. |
|
syncplicity.ws.external.url |
|
string |
https://api.syncplicity.com |
Y/N |
Sets the external web services gateway (API portal) URL. It is required if your account is not based in the US PrivacyRegion. For more information, see Configure the Storage Connector. |
syncplicity.ws.cors |
string |
https://*.syncplicity.com |
N |
Sets the Access-Control-Allow-Origin header value in response. See Cross-Origin Resource Sharing (CORS). Type: list of URLs separated by a semicolon (;). It may contain wildcard (*) entries for domains. Example: |
|
syncplicity.ws.corsexposeheaders
|
string |
Accusoft-Data-Encrypted, Accusoft-Data-SK, Syncplicity-Chunk-Size, Etag, Range |
N |
Sets the |
|
syncplicity.ws.corsheaders |
string |
x-requested-with, authorization, content-range, content-type, Syncplicity-Storage-Cookie, Syncplicity-Storage-Password, Syncplicity-Storage-Authorization, Syncplicity-Link-Password, Syncplicity-Preview-Document-Id, As-User, AppKey, If-Match, Syncplicity-Storage-Refresh-Token, Syncplicity-Storage-Access-Token, Syncplicity-Path, Syncplicity-Syncpoint, Syncplicity-Dir-Id, Syncplicity-Filename, Syncplicity-File-Version, Syncplicity-IRM-Config-Token |
N |
Sets the |
|
syncplicity.httpClient.proxy.enabled |
syncplicity.ws.proxy.enable |
boolean |
false |
N |
Enables/disables the HTTP proxy used for web services. See Configure the Storage Connector. |
syncplicity.httpClient.proxy.host |
syncplicity.ws.proxy.host |
string |
|
N |
Sets the host name of the proxy used for web services. See Configure the Storage Connector. |
syncplicity.httpClient.proxy.port |
syncplicity.ws.proxy.port |
integer |
8080 |
N |
Sets the port number of the proxy used for web services. See Configure the Storage Connector. |
syncplicity.httpClient.proxy.timeout |
syncplicity.ws.timeout |
integer |
30000 |
N |
Sets the timeout in milliseconds used when waiting for a response from the web services. |
syncplicity.https.enabled | Not available in 2.x. Configuration done via syncp-storage-https-configuration.py script. | boolean | false | N | Enables Storage Connector to accept secure connections from the load balancer. See Syncplicity On-Premise Storage Connector SSL Configuration Guide for more details. |
No longer supported in 3.x. Logging level is configured in logger.xml | syncplicity.debug.enable | boolean | false | N |
Enables debug level logging. Since Storage Connector 3.x, logging level is configured in logger.xml. |
syncplicity.versionPageEnabled | syncplicity.versionPage.enabled | boolean | false | N | Enables/disables support for the Version API call. See Enabling Storage Connector support for the Version API call. |
syncplicity.security.obfuscateFilenames | Not supported in 2.x | boolean | false | N | Enables/Disables file name obfuscation in the Storage Connector logs. |
Storage configuration
Setting in Version 3.2 and newer |
Setting in Version 2.22.2 (if different) |
Value Format |
Default Value |
Required |
Description |
---|---|---|---|---|---|
syncplicity.storage.type |
|
string |
|
Y |
Sets the type of storage the Storage Connector is configured to use.
Since Storage Connector 3.2 the |
syncplicity.storage.atmos.url | string | Y/N |
This setting is only required if Sets the base URL and port on which the Atmos installation listens, e.g. This value will be used unless URL and port are set for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.atmos.secret | string | Y/N |
This setting is only required if Sets the base Atmos secret key. It will be used unless a secret key is set for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.atmos.token | string | Y/N |
This setting is only required if Sets the base Atmos authentication token. It will be used unless an authentication token is set for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.atmos.data.url | string | N |
Sets the URL and port on which the Atmos installation listens for storing data, e.g. Make sure that you explicitly include the port number. When set, it overrides the value in |
||
syncplicity.storage.atmos.data.secret | string | N | Sets the secret key for the Atmos installation used for storing data. When set, it overrides the value in syncplicity.storage.atmos.secret . |
||
syncplicity.storage.atmos.data.token | string | N | Sets the authentication token for the Atmos installation used for storing data. When set, it overrides the value in syncplicity.storage.atmos.token . |
||
syncplicity.storage.atmos.image.url | string | N |
Sets the URL and port on which the Atmos installation listens for storing image thumbnails, e.g. Make sure that you explicitly include the port number. When set, it overrides the value in |
||
syncplicity.storage.atmos.image.secret | string | N | Sets the secret key for the Atmos installation used for storing image thumbnails. When set, it overrides the value in syncplicity.storage.atmos.secret . |
||
syncplicity.storage.atmos.image.token | string | N | Sets the authentication token for the Atmos installation used for storing image thumbnails. When set, it overrides the value in syncplicity.storage.atmos.token . |
||
syncplicity.storage.atmos.irm.url | string | N | Sets the URL and port on which the Atmos installation listens for storing IRM data, e.g.url: "https://atmos.internal:443" . Make sure that you explicitly include the port number. When set, it overrides the value in syncplicity.storage.atmos.url . |
||
syncplicity.storage.atmos.irm.secret | string | N | Sets the secret key for the Atmos installation used for storing IRM data. When set, it overrides the value in syncplicity.storage.atmos.secret . |
||
syncplicity.storage.atmos.irm.token | string | N | Sets the authentication token for the Atmos installation used for storing IRM data. When set, it overrides the value in syncplicity.storage.atmos.token . |
||
syncplicity.storage.atmos.archive.url | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the URL and port on which the Atmos installation listens for storing bulk download archives data, e.g.url: "https://atmos.internal:443" . Make sure that you explicitly include the port number. When set, it overrides the value in syncplicity.storage.atmos.url . |
|
syncplicity.storage.atmos.archive.secret | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the secret key for the Atmos installation used for storing bulk download archives data. When set, it overrides the value in syncplicity.storage.atmos.secret . |
|
syncplicity.storage.atmos.archive.token | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the authentication token for the Atmos installation used for storing bulk download archives data. When set, it overrides the value in syncplicity.storage.atmos.token . |
|
syncplicity.storage.azure.accountKey | string | Y/N |
This setting is only required if Sets the base storage account secret key for Azure blob storage. It will be used unless a storage account secret key is set individually for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.azure.accountName | string | Y/N |
This setting is only required if Sets the base storage account name for Azure blob storage. It will be used unless a storage account name is set individually for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.azure.container | string | Y/N |
This setting is only required if Sets the base container name for Azure blob storage. It will be used unless a container name is set individually for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.azure.data.accountKey | string | N | Sets the secret key of the Azure storage account for data. When set, it overrides the value in syncplicity.storage.azure.accountKey . |
||
syncplicity.storage.azure.data.accountName | string | N | Sets the name of the Azure storage account for data. When set, it overrides the value in syncplicity.storage.azure.accountName . |
||
syncplicity.storage.azure.data.container | string | N | Sets the name of the Azure blob storage container for data. When set, it overrides the value in syncplicity.storage.azure.container . |
||
syncplicity.storage.azure.image.accountKey | string | N | Sets the secret key of the Azure storage account for image thumbnails. When set, it overrides the value in syncplicity.storage.azure.accountKey . |
||
syncplicity.storage.azure.image.accountName | string | N | Sets the name of the Azure storage account for image thumbnails. When set, it overrides the value in syncplicity.storage.azure.accountName . |
||
syncplicity.storage.azure.image.container | string | N | Sets the name of the Azure blob storage container for image thumbnails. When set, it overrides the value in syncplicity.storage.azure.container . |
||
syncplicity.storage.azure.irm.accountKey | string | N | Sets the secret key of the Azure storage account for IRM data. When set, it overrides the value in syncplicity.storage.azure.accountKey . |
||
syncplicity.storage.azure.irm.accountName | string | N | Sets the name of the Azure storage account for IRM data. When set, it overrides the value in syncplicity.storage.azure.accountName . |
||
syncplicity.storage.azure.irm.container | string | N | Sets the name of the Azure blob storage container for IRM data. When set, it overrides the value in syncplicity.storage.azure.container . |
||
syncplicity.storage.azure.archive.accountKey | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the secret key of the Azure storage account for bulk download archives data. When set, it overrides the value in syncplicity.storage.azure.accountKey . |
|
syncplicity.storage.azure.archive.accountName | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the name of the Azure storage account for bulk download archives data. When set, it overrides the value in syncplicity.storage.azure.accountName . |
|
syncplicity.storage.azure.archive.container | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the name of the Azure blob storage container for bulk download archives data. When set, it overrides the value in syncplicity.storage.azure.container . |
|
syncplicity.storage.fs.rootDir | syncplicity.storage.fs.rootdir | string | Y/N |
This setting is only required if Sets the rootdir to the mount point of the NFS v3 or v4 server on this server (Storage Connector machine) or local FS mount point. This base value will be used as the common rootdir unless a rootdir is set individually for data, image thumbnails, IRM or bulk download archives in |
|
syncplicity.storage.fs.data.rootDir | syncplicity.storage.fs.data.rootdir | string | N |
(NFS v3 or v4) Sets the rootdir for data. When set, it overrides the value in |
|
syncplicity.storage.fs.image.rootDir | syncplicity.storage.fs.image.rootdir | string | N |
(NFS v3 or v4) Sets the rootdir for image thumbnails. When set, it overrides the value in |
|
syncplicity.storage.fs.irm.rootDir | syncplicity.storage.fs.irm.rootdir | string | N | (NFS v3 or v4) Sets the rootdir for the IRM data. | |
syncplicity.storage.fs.archive.rootDir | Not available in 2.x | string | N | Available in version 3.3 or greater. (NFS v3 or v4) Sets the rootdir for the bulk download archives data. | |
syncplicity.storage.fs.fsTimeout | Not available in 2.x | integer | 4 | N |
Available in version 3.3.1 or greater. (NFS v3 or v4) Sets the maximum wait time (in seconds) to read data from the mount point, before returning an error. When syncplicity.storage.fs.fsTimeout = 5, write/flush timeout is 8. When syncplicity.storage.fs.fsTimeout = 10, write/flush timeout is 10. |
syncplicity.storage.google.host | string | https://www.googleapis.com | Y |
Sets the base Google Cloud Storage API host name. |
|
syncplicity.storage.google.connectTimeout | integer | 20000 | Y |
Sets the base timeout in milliseconds when establishing a connection with Google Cloud Storage. |
|
syncplicity.storage.google.maxretry | syncplicity.storage.google.maxRetry | integer | 6 | Y | Sets the maximum number of retry attempts to perform. If set to 1, retrying is disabled. |
syncplicity.storage.google.readTimeout | integer | 20000 | Y/N |
Sets the base timeout in milliseconds when reading data from an established connection to Google Cloud Storage. |
|
syncplicity.storage.google.sendBufferSize | integer | 1024 | Y/N |
Sets the buffer size in bytes to send. |
|
syncplicity.storage.google.bucket | string | Y/N |
This setting is only required if Sets the base bucket name for Google Cloud Storage. It will be used unless a bucket name is set individually for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.google.authJson | string | Y/N |
This setting is only required if Sets the base authentication credentials JSON for the service account used when accessing Google Cloud Storage buckets. This value will be used unless it is set individually for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.google.data.authJson | string | N | Sets the authentication credentials JSON for data. When set, it overrides the value in syncplicity.storage.google.authJson . |
||
syncplicity.storage.google.data.bucket | string | N | Sets the bucket name for data. When set, it overrides the value in syncplicity.storage.google.bucket . |
||
syncplicity.storage.google.image.authJson | string | N | Sets the authentication credentials JSON for image thumbnails. When set, it overrides the value in syncplicity.storage.google.authJson . |
||
syncplicity.storage.google.image.bucket | string | N | Sets the bucket name for image thumbnails. When set, it overrides the value in syncplicity.storage.google.bucket . |
||
syncplicity.storage.google.irm.authJson | string | N | Sets the authentication credentials JSON for IRM data. When set, it overrides the value in syncplicity.storage.google.authJson . |
||
syncplicity.storage.google.irm.bucket | string | N | Sets the bucket name for IRM data. When set, it overrides the value in syncplicity.storage.google.bucket . |
||
syncplicity.storage.google.archive.authJson | string | N | Available in version 3.3 or greater. Sets the authentication credentials JSON for bulk download archives data. When set, it overrides the value in syncplicity.storage.google.authJson . |
||
syncplicity.storage.google.archive.bucket | string | N | Available in version 3.3 or greater. Sets the bucket name for bulk download archives data. When set, it overrides the value in syncplicity.storage.google.bucket . |
||
syncplicity.storage.isilon.* | string | Y/N |
Deprecated. Since Storage Connector 3.2 there's no separate config for EMC VNX systems. These systems have to be configured as generic NFS v3 or v4 systems, by using |
||
syncplicity.storage.s3.access | string | Y/N |
This setting is only required if
|
||
syncplicity.storage.s3.bucket | string | Y/N |
This setting is only required if Sets the base name for the s3 bucket. It will be used unless a name is set individually for data, image thumbnails, IRM or bulk download archives in |
||
syncplicity.storage.s3.secret | string | Y/N |
This setting is only required if
|
||
syncplicity.storage.s3.region | Not supported in 2.x | string | Y/N |
This setting is only required if You must set URL or region for the s3 data and image properties. You cannot use both url and region as they are mutually exclusive. Example:
|
|
syncplicity.storage.s3.url | string | Y/N |
This setting is only required if
|
||
syncplicity.storage.s3.data.access | string | N | Sets the access key for data. When set, it overrides the value in syncplicity.storage.s3.access . |
||
syncplicity.storage.s3.data.bucket | string | N | Sets the name of the s3 bucket for data. When set, it overrides the value in syncplicity.storage.s3.bucket . |
||
syncplicity.storage.s3.data.secret | string | N | Sets the s3 secret for data. When set, it overrides the value in syncplicity.storage.s3.secret . |
||
syncplicity.storage.s3.data.url | string | N |
|
||
syncplicity.storage.s3.image.access | string | N | Sets the access key for image thumbnails. When set, it overrides the value in syncplicity.storage.s3.access . |
||
syncplicity.storage.s3.image.bucket | string | N | Sets the name of the s3 bucket for image thumbnails. When set, it overrides the value in syncplicity.storage.s3.bucket . |
||
syncplicity.storage.s3.image.secret | string | N | Sets the s3 secret for image thumbnails. When set, it overrides the value in syncplicity.storage.s3.secret . |
||
syncplicity.storage.s3.image.url | string | Y/N |
|
||
syncplicity.storage.s3.irm.access | string | N | Sets the access key for IRM. When set, it overrides the value in syncplicity.storage.s3.access . |
||
syncplicity.storage.s3.irm.bucket | string | N | Sets the name of the s3 bucket for IRM. When set, it overrides the value in syncplicity.storage.s3.bucket . |
||
syncplicity.storage.s3.irm.secret | string | N | Sets the s3 secret for IRM. When set, it overrides the value in syncplicity.storage.s3.secret . |
||
syncplicity.storage.s3.irm.url | string | N |
|
||
syncplicity.storage.s3.archive.access | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the access key for bulk download archives data. When set, it overrides the value in syncplicity.storage.s3.access . |
|
syncplicity.storage.s3.archive.bucket | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the name of the s3 bucket for bulk download archives data. When set, it overrides the value in syncplicity.storage.s3.bucket . |
|
syncplicity.storage.s3.archive.secret | Not available in 2.x | string | N | Available in version 3.3 or greater. Sets the s3 secret for bulk download archives data. When set, it overrides the value in syncplicity.storage.s3.secret . |
|
syncplicity.storage.s3.archive.url | Not available in 2.x | string | N |
|
|
syncplicity.storage.s3.{data|image|irm|archive}.region | Not supported in 2.x | string | Y/N |
You must set URL or region for the s3 data and image properties. You cannot use both url and region as they are mutually excluded. Example:
|
|
syncplicity.storage.s3.pathStyleAccess | Not supported in 2.x | boolean | false | N | In case set to true , enables path-style access to the s3 bucket. In case set to false, virtual-hosted-style is used. More info about the two styles in https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html |
syncplicity.storage.s3.enableV4 | boolean | false | N | (s3 for AWS) Enables/disables request authentication with the AWS Signature Version 4 algorithm. Note that regions eu-central-1 , eu-north-1 and eu-south-1 , as well as all buckets created after June 24th 2020 support only V4 signatures. |
|
syncplicity.storage.s3.maxConnections | integer | 350 | N | (s3 for AWS) Sets the number of simultaneous connections to an individual s3 bucket fused for storing data or image thumbnails. When only a single bucket is used and its name is set in syncplicity.storage.s3.bucket , the total number of simultaneous connections to this bucket is 2 × syncplicity.storage.s3.maxConnections because separate s3 clients are used for data and image thumbnails. |
|
syncplicity.storage.vnx.* |
Deprecated. Since Storage Connector 3.2 there's no separate config for EMC VNX systems. These systems have to be configured as generic NFS v3 or v4 systems, by using |
Thumbnails generation configuration
NOTE: thumbnail is generated only in case of successful, not duplicate upload; thumbnails are crated only for .jpg, .jpeg, .gif, .png files.
Setting in Version 3.2 and newer |
Setting in Version 2.22.2 (if different) |
Value Format |
Default Value |
Required |
Description |
---|---|---|---|---|---|
syncplicity.thumbnail.encrypt | boolean | true | N | ||
syncplicity.thumbnail.infos | semicolon-delimited list of thumbnail infos |
"2,80x80.jpg,80,80,true,true" | N |
Semicolon-delimited list of thumbnail infos. ex- " Thumbnail info properties: [thumbnailType: Byte, fileNameExtension: String, width: Short, height: Short, keepAspectRatio: Boolean, cropImage: Boolean] |
|
syncplicity.thumbnail.supportChunckedUpload |
syncplicity.thumbnail.supportchunckedupload |
boolean | false | N | Enables/disables thumbnail creation for chunked uploads. |
syncplicity.thumbnail.stepPixelLength | syncplicity.thumbnail.steppixellength | integer | -1 | N | Sets the pixel size for each thumbnail scale down step. If set to -1, thumbnails will be scaled down in one step. The smaller are the values for the steps, the better is the thumbnail quality. |
syncplicity.thumbnail.maxPixel | syncplicity.thumbnail.maxpixel | integer | 6000 | N |
Sets the maximum pixel size for thumbnail creation. If set to -1, the pixel size is not limited. Otherwise, thumbnails are created only for images with width or height (in pixels) less than the value specified. In general if in any dimension (width or height) the image has more pixels than this value, a thumbnail will not be generated. |
syncplicity.thumbnail.maxFileSize | syncplicity.thumbnail.maxfilesize | integer | 20 | N | Sets the maximum file size in megabytes for thumbnail creation. If set to -1, the file size is not limited. |
Health configuration
Setting in Version 3.2 and newer |
Setting in Version 2.22.2 (if different) |
Value Format |
Default Value |
Required |
Description |
---|---|---|---|---|---|
syncplicity.health.enabled | syncplicity.health.enable | boolean | true | N | Enables/disables the health monitoring service. |
syncplicity.health.url | string | https://health.syncplicity.com/v1 | Y/N | Sets the base URL of Syncplicity health server used for obtaining health metrics. It is required if your account is not based in the US PrivacyRegion. For more information and a configuration example, see Configure the Storage Connector. | |
syncplicity.health.external.enabled | syncplicity.health.external.enable | boolean | false | N | Enables/disables reporting health metrics to a third party server (monitoring tool). See Introducing Storage Connector health metrics. |
syncplicity.health.external.flushInterval | syncplicity.health.external.flush.interval | integer | 10 | N | Sets the interval in seconds at which Graphite metrics are flushed. See How to configure Storage Connector health metrics using Graphite. |
syncplicity.health.external.host | string | 0.0.0.0 | N | Sets the IP address or URL for the external logging facility (monitoring tool). | |
syncplicity.health.external.port | integer | 2003 | N | Sets the port for the external logging facility (monitoring tool). | |
syncplicity.health.external.prefix | string | N | Sets the prefix to append to the Graphite key. For more information, see Best Practices - Storage Connector health metrics. | ||
syncplicity.health.external.reconnectDuration | integer | 10 | N | Set the timeout in seconds before attempting to reconnect after the connection to the external logging facility (monitoring tool) is lost. | |
syncplicity.health.flushBatchSize | syncplicity.health.flush.batchSize | integer | 50 | N | Sets the number of health metric events to flush during every attempt. |
syncplicity.health.flushPeriod.default | syncplicity.health.flush.period.default | integer | 300 | N | Sets the default interval in seconds at which health metrics are sampled. |
syncplicity.health.flushPeriod.max | syncplicity.health.flush.period.max | integer | 3600 | N | Sets the longest interval in seconds at which health metrics are sampled; the maximum value is 3600. |
syncplicity.health.flushPeriod.min | syncplicity.health.flush.period.min | integer | 10 | N | Sets the shortest interval in seconds at which health metrics are sampled; the minimum value is 10. |
syncplicity.health.sample | integer | 60 | N | Sets the interval in seconds at which health metrics are sampled. | |
syncplicity.health.sampleSize | integer | 1000 | N | Sets the maximum integer of health metric samples to buffer. | |
syncplicity.health.storageFsMountPointMonitoring.enabled | syncplicity.storage.fs.monitorMountPointEnabled | boolean | false | N |
Enables/disables availability monitoring for the NFS or local FS mount point. When enabled, checks if the directory specified by |
syncplicity.health.storageFsMountPointMonitoring.interval | syncplicity.storage.fs.monitorMountPointInterval | integer | 60 | N |
Sets the interval in seconds for the mount point monitoring check if |
StorageVault with Authentication configuration
Setting in Version 3.2 and newer |
Setting in Version 2.22.2 (if different) |
Value Format |
Default Value |
Required |
Description |
---|---|---|---|---|---|
syncplicity.storageVaultAuthentication.enabled | boolean | false | N | Enables/disables the StorageVault authentication feature. | |
syncplicity.storageVaultAuthentication.keyFile | syncplicity.storageVaultAuthentication.key.file | string | /syncp-storage.key | N |
Sets the path to the Secret key file. The path must be absolute, relative paths are not supported. You can change the value of this property to invalidate all previously issued Storage Tokens for security reasons. |
syncplicity.storageVaultAuthentication.ssoUserOnly | boolean | true | N | Only SSO authentication is allowed by default. If this flag is set to false , external users can use password authentication. |
|
syncplicity.storageVaultAuthentication.ssoTargetOrigin | syncplicity.sso.targetOrigin | srting array | * | N | Sets whitelisted SSO domains for StorageVault with Authentication. |
syncplicity.storageVaultAuthentication.saml.entityId | string | N | Sets the Entity ID to be used for SAML requests | ||
syncplicity.storageVaultAuthentication.saml.hostUrl | string | http://127.0.0.1:9000 | N | Sets the external Url for the server or load balancer SAML requests are redirected to. | |
syncplicity.storageVaultAuthentication.saml.idp | string | N | Sets the Identity Provider URL for SAML exchange | ||
syncplicity.storageVaultAuthentication.saml.idpCertFile | string | /etc/syncp/idpcert.pem | N | Sets the path to the certificate file from SAML provider. The path must be absolute, relative paths are not supported. | |
syncplicity.storageVaultAuthentication.confirmationEmail.cc | syncplicity.storageVaultAuthentication.confirmation.email.cc | string |
Y/N |
See Configuring email parameters for StorageVault with authentication in Syncplicity StorageVault with Authentication Configuration Guide | |
syncplicity.storageVaultAuthentication.confirmationEmail.replyTo | syncplicity.storageVaultAuthentication.confirmation.email.replyTo | string | no-reply@syncplicity.com | Y/N | See Configuring email parameters for StorageVault with authentication in Syncplicity StorageVault with Authentication Configuration Guide |
syncplicity.storageVaultAuthentication.confirmationEmail.sender | syncplicity.storageVaultAuthentication.confirmation.email.sender | string | no-reply@syncplicity.com | Y/N | See Configuring email parameters for StorageVault with authentication in Syncplicity StorageVault with Authentication Configuration Guide |
syncplicity.storageVaultAuthentication.confirmationEmail.subject | syncplicity.storageVaultAuthentication.confirmation.email.subject | string | Your Syncplicity One Time Confirmation Code | Y/N | See Configuring email parameters for StorageVault with authentication in Syncplicity StorageVault with Authentication Configuration Guide |
syncplicity.storageVaultAuthentication.confirmationEmail.subjectLocalizations | syncplicity.storageVaultAuthentication.confirmation.email.subjectLocalizations | map | {} | N | This section is used to store localized messages in different languages that are included in emails sent for SVA authentication. See Configuring SMTP on the Syncplicity Storage Connector in Syncplicity StorageVault with Authentication Configuration Guide. |
syncplicity.storageVaultAuthentication.blackList.enabled | true | N | Enables/disables email blacklisting. | ||
syncplicity.storageVaultAuthentication.blackList.emailDomains | semicolon-delimited list of domains |
N | Defines blacklisted email domains. Users whose email addresses end in these email domains will not be allowed to access the authentication secured StorageVault. A semicolon (;) is used as the separator character. Example: @email_domain1;@email_domain2 |
||
syncplicity.storageVaultAuthentication.accessTokenTTL | integer | 60 | N | Time to live (TTL) period in minutes for storage authentication tokens. 0 is equal to infinite TTL, i.e. tokens never expire. | |
syncplicity.storageVaultAuthentication.filterInvalidEmailEnabled | boolean | false | N | Enables filtering of invalid emails from authorized external users list. | |
syncplicity.storageVaultAuthentication.filterBlacklistDomainEnabled | boolean | false | N | Enables filtering of blacklisted domain emails from authorized external users list. | |
syncplicity.storageVaultAuthentication.refreshTokenTTL | integer | 1440 | N | Storage Refresh Token TTL in minutes. 0 is equal to never. | |
syncplicity.storageVaultAuthentication.shortAccessTokenTTL | integer | 30 | N | Storage Short-Lived Access Token TTL in seconds. Value 0 means no expiration for tokens. | |
syncplicity.storageVaultAuthentication.tokenEmission | string | default | N |
If set, this value is used as a salt for every issued Storage Access and Storage Refresh token, and all previously used tokens become invalid. Moreover, all tokens issued with a different salt will become invalid whenever this value is changed. You can change the value of this property to invalidate all previously issued Storage Tokens for security reasons. |
Syncplicity Rights Management configuration
More details about this functionality available in Configure Storage Connector to enable Syncplicity Rights Management
Setting in Version 3.2 and newer |
Setting in Version 2.22.2 (if different) |
Value Format |
Default Value |
Required |
Description |
---|---|---|---|---|---|
syncplicity.storage.plugins.irm.tmpPath | string | /var/lib/syncp-storage/irm-cache | N | Sets the location where IRM protected files are temporary stored on the Storage Connector | |
syncplicity.storage.plugins.irm.syncrm.proxy.enabled | syncplicity.irm.proxy.enable | boolean | false | Y/N | Enables/disables the Information Rights Management (IRM) proxy that is used in order to connect from on-premises Storage Connector nodes to a cloud hosted IRM server. |
syncplicity.storage.plugins.irm.syncrm.proxy.host | syncplicity.irm.proxy.host | string | Y/N | Sets the IRM proxy host name. | |
syncplicity.storage.plugins.irm.syncrm.proxy.port | syncplicity.irm.proxy.port | integer | 8080 | Y/N | Sets the IRM proxy port number. |
syncplicity.storage.plugins.irm.fileRetrieveTimeout | integer | 60 | N | Sets the timeout in seconds when writing file from storage to disk | |
syncplicity.storage.plugins.irm.poolRefreshInterval | syncplicity.storage.plugins.irm.refreshInterval | integer | 1200 | N | Sets the interval in seconds to refresh pooled connections. |
syncplicity.storage.plugins.irm.poolSize |
syncplicity.storage.plugins.irm.connectPoolSize | integer | 5 | N | Sets the maximum number of IRM connections to keep active. |
Syncplicity Bulk Downloads configuration
More details about the configuration available in Configure On-Premise StorageVaults for downloading files and folders in bulk
Setting in Version 3.3 and newer | Setting in Version 2.22.2 (if different) | Value Format | Default Value | Required | Description |
---|---|---|---|---|---|
syncplicity.bulkdownload.enabled | Not available in 2.x | boolean | true | N | Available in version 3.3 or greater. Determines whether the Bulk download feature is enabled for this connector. |
syncplicity.bulkdownload.maxThreads | Not available in 2.x | integer | 3 | N |
Available in version 3.3 or greater. Number of worker threads that can create archives in parallel. For Storage Connector instances that are dedicated to zip creation only, the value should be less than or equal to the total thread count for that instance (e.g. 2*CPU core count if hyper-threaded). For Storage Connector instances that are not dedicated to zip creation only, the value should be scaled down according to minimum free CPU time. E.g. if instance had up to 75% total cpu utilisation with |
syncplicity.bulkdownload.interval | Not available in 2.x | integer | 30 | N |
Available in version 3.3 or greater. Time interval (in seconds) indicating how often a check for pending jobs is made by the Storage Connector. Could be decreased to 15-20 seconds in case of download of bigger number of small-sided files. |
syncplicity.bulkdownload.compressionLevel | Not available in 2.x | string | NO_COMPRESSION | N |
Available in version 3.3 or greater. Determines the compression level for the archiving jobs. Accepted values:
Could be used for tuning the zip creation performance and optimising the size of the created zip file. Depends on what type of files are being compressed. |