Provider Settings

These settings define provider specific configuration options.

After a new Provider (formerly called a “Distributor”) has been created by the Default Provider via the Administration Console, the new Provider’s settings can be changed by clicking Server Management -> Provider Settings.

These settings are split up into several categories, which are listed below (in alphabetical order).



A comma separated list of allowed languages for the activation pages. For each A set of activation pages must be available for each language defined here.


The activation page’s language depends on the language chosen by the user. If the user’s language is not supported, the default language specified here will be used.

The default HTML pages must always be available.

API Settings


Value for the license reference column when creating licenses using the Administration Console. Note that if you use this setting then EXT_LICENCE_REF_UNIQUE must be set to False.


If set to True, the API will not require and check the checksum that usually needs to be provided in API calls. This might be useful when developing or testing the API functions.


If set to True, each new user created via the API will receive a Default Depot as defined in the HOSTSERVER provider settings. If set to False you can create and assign Depots to users via the API.


Comma-separated list of IP addresses that are allowed to perform API calls.

Two different providers can not use the same IP address, because the IP address will be used to identify the Provider. This is done for security reasons, as you may only access your own customers, licenses, and other data belonging to your Provider.

Exception: The Administration Console (which uses API functions) allows each Provider to login if the above value <APIAllowSettingDistributor> is enabled. It’s also possible to add more than one IP address if you want to access the API from different machines.


When user change notification is enabled (see API_SEND_NOTIFICATIONS), this setting specifies the URL to which the change information is sent. If not set, the changes are written to the log.

Further details are provided in the chapter User Change Notifications.


This value will be returned for various API calls if the calling user belongs to another Provider. For more details, please look in the API documentation.


Set to True to enable logging of API requests in the API log. The value is False by default.


If set to True, the API will send mails using the API mail templates for various actions like chaning the email or password. A list of mail templates is described in Mail Templates for API Actions.


Set this setting to True to enable user change notifications. When enabled you must also set API_NOTIFICATION_URL.

See User Change Notifications, for more details.


The API will normally behave like a TeamDrive Client, meaning that access to not activated user accounts will return an error. Set this option to True to allow API access to not activated accounts.


To allow API access from the web portal. Each provider must set the IP address or list of IP addresses of the web portal to allow users to login using the web portal. Provider which don’t configure this IP will not allow their users to use the web interface to access their spaces. The IP of one web portal could be used by more than one provider.


Which characters are allowed for usernames using the API. This value must be identical to the value set in the DISTRIBUTOR file. For further details, see reg-name-complexity (default: basic-ascii).


These settings are used to configure access to an external Authentication Service (see External Authentication).

When referenced by the TeamDrive Client, all URLs (except VERIFY_AUTH_TOKEN_URL) below include the parameters that specify details about the client.

The international language code of the current language of the client.
The Provider code in use by the client.
Specifies the platform of the client: mac, win, linux, ios, android or unknown.
The size of the display area for the requested page: width x height in pixels (e.g.: 400x500).
This is the cookie stored by the client which was passed to the client after a successful external user authentication (see Login Procedure).


This URL points to the Change Email page of the external Authentication Service.


This URL points to the Login page of the external Authentication Service.

By default, this page is set to:


This URL points to the Lost Password page of the external Authentication Service.

By default, this page is set to:


This URL points to the Registration page of the external Authentication Service.

By default, this page is set to:


Set this value to the URL that reference the page used to setup two-factor authentication, if this is supported by the external Authentication Service.

By default, this page is set to:


Maximum length of time (in minutes) user may remain logged in before they are required to enter their password again.

If this value is 0, users are never promoted to re-enter their password.


Set to True if you want to use an external Authentication Service.

When enabled, this activates the various external Authentication URLs: AUTH_CHANGE_EMAIL_URL, AUTH_LOGIN_URL, AUTH_LOST_PWD_URL, AUTH_REGISTER_URL, AUTH_SETUP_2FA_URL and AUTH_VERIFY_PWD_FREQ.

If values for these URLs are not specified, then they default to pages provided by the Registration Server.


This URL is used by the Registration Server to verify an Authentication Token, sent by the client after login using the Authentication Service.

CLIENT Settings


This setting determines whether user’s of the Provider are permitted to access a Web Portal.

Possible values of the setting are:
  • permit: All users are permitted to login to Web Portals. This is default value of the setting.
  • deny: Web Portal access is denied to all users.
  • peruser: Access is determined by the “Web Portal Access” capability bit.

The “Web Portal Access” capability bit represents user-level permission to access a Web Portal. The capability bit is only used if ALLOW_WEB_PORTAL_ACCESS is set to peruser. The “Web Portal Access” capability bit can only be set in the Admin Console.


Setting the permission to deny will not be recognized by running container instances on the Web Portal. You have to stop all running docker instances manually.

Note that access to a Web Portal may be denied by the Web Portal itself. This is determined by the Web Portal AllowedProviders setting, which contains a list of Providers that are permitted to access the Web Portal.

Further access control to a Web Portal may be built into the external Authentication Service which is used by the Web Portal, if the Web Portal uses such a service. For example, the LDAP/AD Authentication Service may limit login to the Web Portal to users in a specific LDAP/AD group.


Even if access for the user is granted, he might not be able to join/activate his spaces using the Web Portal. Access to the spaces depends on the default value for allow-webaccess-by-default=true/false (default: true) and on the web access rights for a space created with a client 4.3.2 or newer.


A list of allowed Client Provider Codes, besides the Provider’s own code This refers to the Provider Code in the TeamDrive Client’s DISTRIBUTOR file. The default value is ‘*’, which means all codes are allowed. ‘*.’ means all Provider which exists on this Registration Server are allowed.

This setting caters for Provider that have a specific version of the TeamDrive Client and want to ensure that only this type of client is used by the Provider’s users. Such versions are identified by the Provider Code specified in the DISTRIBUTOR file. Since the DISTRIBUTOR file is signed it cannot be manipulated on the client side, and therefore, this value can be trusted.


It is highly recommended that Provider always allows the standard TeamDrive Client (which has the TMDR code) in addition to any others.


When set to False, the Registration Server will return an error if the user attempts to change his/her email address.

If external system (for example, an LDAP or AD server) manages the user registration data, changing the email address in the TeamDrive Client should be disabled. You may use the API functions to synchronize email address changes in the external system with the email address stored for the user on the Registration Server.


This is a server-side setting only, if you set it to False you need to add enable-change-email=false to the CLIENT/CLIENT_SETTINGS Provider setting. See chapter enable-change-email=true/false (default: true) for details.


Set to False if a confirmation email (also known as activation email) should be sent to users after login on a new device. In this case, the device is not activated until the user clicks a link in the email.

If set to True (the default), new devices are automatically activated and the user will only receive a notification email instead of a confirmation email.


The confirmation email should not be confused with the activation email which is always sent when a user registers for the first time.


This setting is used to allow the registration of users with usernames that match the standard “magic username” pattern. This is usernames of the form: “$AAAA-9999999....”, where AAAA is the distributor code, and 9999999.... is any number of digits.

The TeamDrive Client software does not display magic usernames. If a user has a magic username, then the user’s registration email address is used in all user interfaces, instead of the username. Alternatively the user’s “display name” is shown in the user interface.


The caller must ensure that the given username is unique.


This setting controls whether users can create new accounts on the Registration Server using the TeamDrive Client. Set the variable to False if your users were imported into the Registration Server or some form of external authentication is used.

When set to False, the Registration Server will return an error if the user attempts to register.


This is a server-side setting only, if you set it to False you need to add enable-registration=false to the CLIENT/PRE_LOGIN_SETTINGS provider setting. See chapter enable-registration=true/false/default (default: true) for details.


When set to False, the Registration Server will return an error if the user attempts to change his/her password.

If external system (for example, an LDAP or AD server) manages the user registration data, changing the password in the TeamDrive Client should be disabled.


This is a server-side setting only, if you set it to False you need to add enable-set-password=false and enable-lost-password=false to the CLIENT/PRE_LOGIN_SETTINGS provider setting. See chapter enable-set-password=true/false (default: true) and enable-lost-password=true/false (default: true) for details.


This is a list of networks (in CIDR notation) or IP addresses that identify users of the Provider. Using this setting, a Provider can determine that certain networks “belong” to the Provider. For example, any company that has been allocated a Provider Code can take ownership of own networks (as determined by global IP address ranges), and use this fact to control TeamDrive Clients started in those networks.

When a TeamDrive Client connects to the Registration Server, and before the user has logged in, the server determines the client’s IP address and checks whether the client is running in a network that has been specifically allocated to a Provider. If so, then the Provider Code is sent to the client and this overrides Provider Code in the DISTRIBUTOR file. This way, if the user registers after this point, the user will be automatically allocated to the Provider that owns the network in which the client was started.


These settings are sent to the client after registration or login.

These settings can be used to configure the behaviour of the TeamDrive Client as required by the Provider. They will override any settings made on the client-side, and also override the global Registration Server ClientSettings setting as describe in Client Settings.

Note that after registration or login, the user’s Provider is fixed, and therefore the Provider Code in the DISTRIBUTOR file, or the network (see Client Settings) in which the client is stated doesn’t play a role any more.

For a complete list of allowed settings see chapter Login and Registration Client Settings


Set to True if the user’s external reference column must be unique. Set this value to True of you with to use the reference column in the user account to identify user’s via the Registration Server API or when using CSV import.

If set to False then this column is a free field which can be set to any value you like.


This is the value in bytes to limit the amount of data which can be handled by a free client over all Spaces. The limitation will be shown in the client if he is reaching the 75 % border. A progress bar will be visible right above the status bar in the client. If the user will reach the 100 % he can still synchronize data, but the client is switching to meta data synchronisation. Downloading the contents of the files must be initiated manually by the user for each single file and version.


Use this setting to create an “isolated email scope” for users of the Provider. This means that the email addresses used by the users may be in use by other users, but must be unique with regard to other users of the Provider.

When this setting is set to True, the users of an isolated email scope can not be found via their email address. Users can stil be found using there username. In order to find a isolated user a via the email address, you must set the Client setting enable-provider-only-search to true. In this case, however, the TeamDrive user will only see users belonging to his own Provider.

Note that users of an isolated email scope will never receive store forward invitations (see allow-store-forward-invitations=true/false (default: true)). Store forward invitations are only sent to globally visible email addresses.


Any clients with a version below this may not register a new device. The default is For setting up a new server you might increase the minimum client version to if you want to support only version 4 clients.


These settings are sent to the TeamDrive Client before login or registration. As a result, they can be used to configure login and registration in the same manner as settings within the DISTRIBUTOR file. Settings from the server always override client-side settings, so these settings will also override the values in the DISTRIBUTOR file.

The Provider of the user must be ascertained before the pre-login settings can be sent to the client. Before login or registration, the Provider of the user is either determined by the Provider Code in the DISTRIBUTOR file or the IP address of the client, if it is found to be in a network belonging to a specific Provider. The IP address has priority over the DISTRIBUTOR file.


This setting determines how a user account is identified by the user. In other words, what type of name is used on login to TeamDrive. It may be set to one of the following: username, email or default.

After an upgrade to version 3.6, this setting will be set to email, if the setting USE_EMAIL_AS_REFERENCE was set to True. Note that USE_EMAIL_AS_REFERENCE has been deprecated and removed in version 3.6.

username:This means that user accounts are always identified using a username. A username is a unique identifier specified by the user. Usernames are globally unique, which means they uniquely identify a user over all TeamDrive Registration Servers.
email:This means that user accounts are identified using the user’s email address. In this case, the account does not have a username. Whether the email address is unique depends on the Registration Server settings EmailGloballyUnique and UserEmailUnique, and also on the Provider setting ISOLATED_EMAIL_SCOPE.
default:This means that both username and email address identification is allowed when creating a new user account. If the username is omitted, then the Registration Server will assume that email address identification is required.

If an email address is used to identify an account, then the Registration Server automatically generates a username called the “magic username”. A magic username has the form $<provider-code>-<integer value>, for example $ACME-12345. The user is not aware of the magic username, and does not ever use this name to login, and it is not displayed in the TeamDrive GUI (except in some older versions of the TeamDrive Client and servers). Magic usernames are intended for internal use by the TeamDrive only. However, it can be used to reference a user through the Registration Server API.

If email addresses are allowed as identify user accounts then the Client Setting allow-email-login must be set to true, so that your users can login using an email address. This value is set to true by default. Note that, in this case, login with the email address is also allowed when a user account is identified by a username. However, it may be that the email address is not globally unique, which can lead to login failure. The TeamDrive Client, however, can handle this situation, and allows the user to select one of a number of user accounts, further identified by the Provider code.

Note that once an account is created with either username or email identification this cannot be changed.


Users can be created by importing a CSV file. The CSV file can either uploaded manually using the Administration Console, or via the Registration Server’s file system.

An Auto Task must be enabled so that the uploaded files will processed. See chapter Adding Users via CSV File Import in the Registration Server Administration Guide).

The success or error logs can be downloaded using the Administration Console or from the Registration Server’s file system.


Set to False if the department may not be changed by the CSV Import.

CSV_ERROR_DIR (optional)

Error logs for not imported users will be written to this folder. If not defined, you will find the value in the database using the Administration Console.


This setting specifies which column will be used to identify a user in the CSV import. Valid options are: username, email, reference and authid.

See CSV File Structure for more details about this setting.


The switch enables the CSV import functionality. You may specify an upload hotfolder (via the CSV_UPLOAD_DIR setting), or upload the data to be imported directly via the Administration Console.

CSV_SUCCESS_DIR (optional)

Success logs for imported users will be written to this folder. If not defined, you will find the value in the database using the Administration Console.

CSV_UPLOAD_DIR (optional)

CSV hot folder. If not defined, the CSV processing will just use the database. If defined, the contained files will be imported to the database and processed from the database record. Processed CSV files can be downloaded again from the Administration Console, if necessary.


Enable this setting to use a hotfolder for importing CSV files.


When set to True, users not found in a CSV import file are disabled. This feature only works if the “department” field is identical for all records in the import file. Only users in the specified Department will be disabled.

In other words, to use this feature, you must create a CSV import file per department. If the Department field is not used, then all users may be placed in the same import file.

EMAIL Settings


The brand name that is substituted for [[BRAND]] in e-mail templates. If not set, the default TeamDrive will be used.


Each Provider Code defines a comma separated list of languages allowed for the emails. A set of templates is required for each language. The language used depends on the language setting of the user’s record.


If the user is using a language which is not listed in <AllowedEmailLanguage>, the <DefaultEmailLanguage> will be used instead.


This address will be used for invitation mails. Its usage depends on the value in USE_EMAIL_SENDER_EMAIL.


The activation mail will list this email address as the sender.


This setting specified the suport email address. A notification will be sent to this address when support related information has been uploaded by a user.


When set to True the email address of the sending user appears in the “From:” header of emails sent to unregistered users. When set to False, the email specified by EMAIL_SENDER_EMAIL when be used for the “From:” header.


A TeamDrive Enterprise Host Server is registered using a Provider Code and the URL of the Registration Server. You can also use the Administration Console to define a default Host-Server for Clients which register using said provider code.

The default provider of a Registration Server is allowed to configure any Host Server on the Registration Server to accept users with different provider codes.

This way it’s possible to use only one Host Server for multiple providers on a Registration Server.


If your Host Server accepts API requests via SSL/TLS, you can enable SSL communication between the Registration Server Administration Console and Host Server API by setting this value to True.


Set to True if all Space Depots of a user should be distributed automatically to all of his devices.

If you connect a Host Server to your Registration Server, the Clients will receive a default Space Depot upon registration, if the provider setting HOSTSERVER/HAS_DEFAULT_DEPOT has been set to True. Each user has one default space depot. It’s possible to add more space depots to users but only the default space depot can be retrieved by newly registered clients.

Additional Space Depots need to be sent to a user’s devices via the Administration Console (by clicking Send existing depots to <user> devices, or by setting AUTO_DISTRIBUTE_DEPOT to True.

This will also distribute the other depots belonging to the user to a new client installation.


Set to True if a Host Server for creating default Depots is available and Clients should receive a default Depot from the server selected in HOST_SERVER_NAME.


The size of the default depot for the user in bytes. Default is: 2 GB = 2147483648 Bytes


Please choose a Host Server from the list to use as the default depot server for new clients.


The URL of the Host-Server will automatically be entered in this field after you have selected a host server from the HOST_SERVER_NAME list above.


The monthly allowed traffic for the user in bytes. Default is: 20 GB = 21474836480 Bytes


This setting may be used to specify that a certain Depot should be used as default Depot for all users of a Provider.

In other words, the specified Depot will be assigned to all users of the Provider, instead of the standard behaviour of creating a new Depot for each user.

This value must be set to the local database ID of the Depot. Note that this is not the Depot ID, which is the ID of the Depot on the Host Server. If the PROVIDER_DEPOT is set by the Admin Console, then this will be done automatically.

LICENSE Settings


Set to True to allow the creation of licenses for this provider. This setting can only be changed by the Default Provider.


Set to True to allow the management of licenses for this provider. This setting can only be changed by the Default Provider.


Numerous features can be bound to a license. The default features are set using this setting. This value uses a bit-mask for enabling or disabling the individual feature; each feature has an assigned value (which is a power of 2) and the value of this setting is equal to the sum of all enabled feature values:

1 = Banner
The Banner feature is only used by TeamDrive 3 clients. It specifies that space in the user interface is allocated for the display of a banner which can be configured on the Registration Server (see Managing Banners).
2 = WebDAV
This feature enables the storage of Spaces on a WebDAV server. WebDAV access is also enabled as part of the Personal, Professional or SecureOffice features.
4 = Personal

The Personal feature is used to create TeamDrive Personal licenses. Such licenses are only relavent for TeamDrive 3 clients. TeamDrive 4 clients regard Personal and Professional licenses as identical.

The Personal feature disables certain Professional-only features, including: limiting of versions stored in the Hosting server, publish file functionality, various email notifications and support for network drives.

TeamDrive 3 clients impose further restrictions on usage if they are not assigned a Personal or Professional. In particular, the amount of data handled by the client is limited to 2 GB by default.

TeamDrive 4 clients do not have this restriction, or any other License associated restriction. Instead, TeamDrive 4 usage is free for non-commercial applications. Anyone using TeamDrive in a commercial environment is required to purchase a Professional license (see below).

8 = Professional

The Professional feature is used to create TeamDrive Professional licenses. On a TeamDrive 3 client, the Professional license enables certain Professional-only features (see above).

On the TeamDrive 4 client, this license disables the daily dialog which requires the user to confirm that he/she is non-commercial user of TeamDrive.

16 = Restricted Client
This feature enables restrictions that are specified using certain client settings. The only setting currently effected by this feature is The active-spaces-limit setting. This setting can be specified in CLIENT_SETTINGS Provider setting. When specified, it only applies if the Restricted Client feature is set.
32 = SecureOffice
The SecureOffice feature is identical to the Professional feature, but adds support for the SecureOffice version of TeamDrive.

Example: It is common practice for a default free license to include the Banner and WebDAV features. The Banner feature has the value 1 and the WebDAV feature has the value 2. So to use both, set the value of the DEFAULT_FREE_FEATURE setting to the value 3, which is derived by adding the feature values: 1 + 2.

For more details about the features, please have a look at TeamDrive Client-Server interaction.


Define a specific license that will be assigned to all Clients upon registration. This license’s features will override the features defined in the DEFAULT_FREE_FEATURE setting.

Setting this value will also disable the PROFESSIONAL_TRIAL_PERIOD setting. When a default license is defined, a Professional trial period is no longer possible, and will not be permitted by the client software.


Set to True if you wish to use licenses with a Valid Until date. When set to False, licenses with an existing Valid Until date will not expire.


Set to True if the external license reference should be unique. This is the default value.

If you set API_ADMINCONSOLE_LIC_REF, then this setting must be False.


This is the number of days for the one-off professional trial period, set to 0 if no trial is allowed.

LOGIN Settings


A comma-separated list of IP addresses allowed to login to the Administration Console.


Set to True to enable two-factor authentication via email for logging into the Administration Console (please notice that the two-factor authentication for the admin console is independent from the new client two-factor authentication added in version 3.6).


The REDIRECT settings determine the landing pages reached when links are clicked or activated in the TeamDrive Client.

The Provider may specify a URL for each REDIRECT target page. If not specified a Registration Server global default URL will be used (see Redirect URLs).

The URLs may contain a number of variables, which are replaced by the appropriate values:

The international language code of the current language of the client.
Base 64 encoded username. This variable is only supplied for the REDIRECT_PURCHASE URL.
Specifies the product ordered. Only provided for the REDIRECT_ORDER URL. Currently the only possible value is TDPS.


A list of allowed languages for the redirector pages.


Default language in case that the user’s language is not in the list of REDIRECT_ALLOWED_LANG. Use [lang] in your links to replace them with the user’s language.


This URL redirects to a page where the Provider’s version of TeamDrive can be downloaded.


This URL redirects to the Provider’s FAQ (frequently asked questions) page.


This URL redirects to the Provider’s forum page.


This URL redirects to the Provider’s help page.


This URL redirects to the Provider’s privacy page.


This URL redirects to the Provider’s home page.


This URL redirects to the Provider’s product order page. The variable [product] can currently only be ‘TDPS’.


This URL redirects to a Provider information page which describes all available Provider codes which may be used during registration.


This URL redirects to the Provider’s page for purchases licenses. The variable [user] is a base 64 encoded username.


This URL redirects to the Provider’s tutorials page.


This URL redirects to the Provider’s user-invite-user page.


You can configure a referral program as an incentive for users to invite other users in order to increase their free storage limit.


A “referral” is only valid if:

  • The invited user did not have an account before getting invited
  • The user was invited by email
  • The invited user registers using the same email address that the invitation was sent to (so that a match can be made)

The Registration Server will do the matching when the invited user activates his new account, increasing the depot values and sending the notification mails to the inviter (see Templates for Client Actions).

This feature requires an active Host Server and default Depots for your users (see above HOSTSERVER Settings).


The maximum amount of new users which can be invited by an existing user.


The promotions upgrade size in bytes. The depot limit and free client limit are increased for both the new and for the existing user.

TDNS Settings

If TDNS access is enabled for the Registration Server, each Provider needs its own Server ID and TDNS Checksum.


The checksum which will be added to the checksum over the request which will be send to the TDNS. For more details please look at TeamDrive Name Server (TDNS).


The ID of the Provider’s entry in the TDNS.

UPDATE Settings

The TeamDrive Client checks if there are updates available for its version. You can use the following settings to define the supported languages for the update notification. How the update notification will be configured using the Administration Console is described in chapter.


A comma separated list of allowed languages.


Which update information HTML page will be displayed for the user, depends on the chosen language of the user.

The language of the displayed update information HTML page depends on the user’s language.

If the language of the user is not supported, the default language specified here will be used. The default HTML pages must always be available.


A test user can be defined using the Administration Console. This user will always get the update notification in their client even if they are already using a newer version. This allows you to test the update notification without up- and downgrading a TeamDrive client version.