Login and Registration Client Settings

The following settings influence the behaviour of the TeamDrive Client during login and registration. They can be set in the DISTRIBUTOR file installed on the Client, or as (pre-)login settings on the Registration Server, by adding them to the following Provider Settings:

CLIENT_SETTINGS
Client settings which are applied after login (multiple settings must each be placed on a new line). See CLIENT_SETTINGS for more details.
PRE_LOGIN_SETTINGS
Client settings which are applied before login (multiple settings must each be placed on a new line). See PRE_LOGIN_SETTINGS for more details.

The following TeamDrive Client settings can be adjusted:

active-spaces-limit (default: 0)

Limit the amount of active spaces in the client. This setting only has an effect if the “Restricted” license feature is set on the user’s license as described in Using a “Restricted” Client License Model. 0 means unlimited.

This setting should not be set explicitly in CLIENT/CLIENT_SETTINGS. The LICENSE/ACTIVE_SPACES_LIMIT provider setting automatically sets the setting when set to a non-zero value (see ACTIVE_SPACES_LIMIT).

allow-email-login=true/false (default: false)

In case of using an external reference in the username field as described in require-profile=true/false (default: false), you should allow email login. Note that, although this is usually the case, the email field is not necessarily unique in TeamDrive. If the same email address is used by different users, the client will show a drop-down list of all possible users after the email address was entered.

This setting may be used in PRE_LOGIN_SETTINGS.

allow-store-forward-invitations=true/false (default: true)

Invitations to users that do not exist, will be invited using a store forward invitation. The user must register with the same email address the invitation was sent to. Should be disabled if the Registration Server does not allow external users to register or in case that the email will be used as username, which might be a problem if the users cannot distinguish between known and unknown users. In the case of an unknown user, the client will automatically send a store forward invitation if the username looks like an email address.

This setting may be used in CLIENT_SETTINGS.

allow-webaccess-by-default=true/false (default: true)

Defines how spaces will be handled which were created by older clients without the web access functionality (see enable-space-webaccess (default: user-default)). Setting the value to false, will prevent joining/activating a space using the Web Portal even if the user created the space or was invited to the space. A mobile or desktop client version 4.3.2 or newer must be used to allow web access for the space. Setting the value to true will allow joining/activating a space using the Web Portal for all spaces beside spaces created with client version 4.3.2 and explicitly deny web access.

This setting may be used in CLIENT_SETTINGS.

auto-accept-invitation=true/false (default: false)

When set to true, the TeamDrive Client will accept all Space invitations automatically and join these Spaces.

This setting may be used in CLIENT_SETTINGS.

auto-accept-invitation-mode (default: archived)

The mode of operation when joining Spaces automatically (TeamDrive Client Version 4.2.2 or later required). Possible values are: non-offline-available, offline-available, archived, virtual.

This setting may be used in CLIENT_SETTINGS.

auto-invite-users=list

A list of user names to be automatically invited into newly created Spaces with specified default-invitation-rights. The list has to be separated by semicolons and enclosed with double quotes in the settings file. Example: auto-invite-users=”abc;def”

This setting may be used in CLIENT_SETTINGS.

check-for-updates=true/false (default: true)

The TeamDrive Client will check for software updates on the Registration Server. Set this value to false, if a software distribution tool will be used to deploy Client installations to your users.

This setting may be used in CLIENT_SETTINGS.

default-join-mode (default: default)

The mode of operation when joining Spaces (TeamDrive Client Version 4.2.2 or later required). Possible values are: default, non-offline-available, offline-available, virtual.

This setting may be used in CLIENT_SETTINGS.

default-publish-expiry-days (default: 0)

How man days will an unecrypted published file (see enable-publish=true/false/default (default: true)) be kept on the server until it will autoamtically removed on the server. 0 means unlimited and the user has to unpublish the file by himself.

This setting may be used in CLIENT_SETTINGS.

default-server-mode (default: default)

Defines if the default server for creating spaces can be modified by the user or not. The following values are allowed:

  • default (default): means that the users selected server is used, unless he selects the same as the server in which case the user selection is cancelled
  • ignore-server: means that the user selected default server is never changed by the server
  • ignore-user: means that the server default server is used, and the user cannot change the selected server
  • use-selected: means that the server, per user, selected server is used, and the user cannot change the selected server

This setting may be used in CLIENT_SETTINGS.

default-server-version-count (default: -1)

How many versions of a file will be kept in the client before they will be automatically deleted. -1 means unlimited. If not set to unlimited the value must be >= 1.

This setting may be used in CLIENT_SETTINGS.

display-full-name=true/false (default: false)

Should only be enabled in combination with require-profile as described in require-profile=true/false (default: false). If the value is set to true, the client will show the profile name instead of the username.

This setting may be used in CLIENT_SETTINGS.

enable-browser-change-email=true/false (default: false)

Whether a user may change his email address using the default web browser on the system. This requires the Provider setting AUTH_CHANGE_EMAIL_URL to be defined to point to a web page that supports changing the email address.

This setting may be used in CLIENT_SETTINGS.

enable-browser-lost-password=true/false (default: true)

If the standard and web-based password lost panels are disabled, the TeamDrive Client will direct users to a specified web-page where the user can request a forgotten password. If you do not have such a page, then setting this variable to false will remove the lost password button from the login dialogue.

This setting may be used in PRE_LOGIN_SETTINGS.

enable-browser-registration=true/false (default: true)

If both standard web-based registration panels are disabled then the TeamDrive Client will direct the user to a web-page when the registration button is clicked. If you do not have such a web-page, then setting this variable to “false” will remove the registration button from the login dialogue.

This setting may be used in PRE_LOGIN_SETTINGS.

enable-change-email=true/false (default: true)

Whether a user may change his email address in the TeamDrive Client application. If the email address will be determined by another system (e.g. when using external authentication), it may not be appropriate for users to change their email addresses via the TeamDrive Client.

This setting may be used in CLIENT_SETTINGS.

enable-enterprise-server=true/false (default: true)

You can disable the usage of a Hosting Service.

Note

Only the creation of Spaces using a Hosting Service is disabled. Accepting invitations to a Space which is located on a Hosting Service is always possible.

This setting may be used in CLIENT_SETTINGS.

enable-import-server=true/false (default: true)

Defines whether WebDAV, TDPS or Host-Server Depot files can be imported into the client.

This setting may be used in CLIENT_SETTINGS.

enable-key-repository=true/false (default: true)

Enable/disable the Key Repository. If enabled, the user’s space keys are stored encrypted using the user’s password on the server. When the user installs TeamDrive on a new device, the space keys are retrieved from the Key Repository and the user is able to activate the spaces in the new installation.

If the Key Repository is disabled, after installing a new device, the user must be re-invited to all spaces in order to gain access to the spaces on the new device. If the user already has a TeamDrive installation he/she can do a self-invitation.

This setting may be used in CLIENT_SETTINGS.

enable-login=true/false/default (default: true)

This setting can be used to disable the standard login dialogue. If disabled, you should enable the embedded browser-based login using the enable-web-login setting. If both standard and web login are enabled, you can determine standard login to be the default by setting this variable to default instead of true.

This setting may be used in PRE_LOGIN_SETTINGS.

enable-lost-password=true/false (default: true)

A user can request a new password within the login dialogue. Disable this if the user’s passwords are not managed by the Registration Server (for example when using external authentication). See also enable-set-password.

This setting may be used in PRE_LOGIN_SETTINGS.

enable-network-volumes=true/false (default: true)

Clients are allowed to create/use spaces on a network volume.

This setting may be used in CLIENT_SETTINGS.

enable-provider-panel=true/false (default: false)

Defines if the user should be able to enter a different provider code prior to log in/registration.

This setting may be used in PRE_LOGIN_SETTINGS.

enable-publish=true/false/default (default: true)

Clients are allowed to publish files unencrypted so that they can be accessed without using a TeamDrive Client.

This setting may be used in CLIENT_SETTINGS.

enable-registration=true/false/default (default: true)

The registration panel in the login dialogue that allows a user to create a new user on the Registration Server. If users are created by some other mechanism, then you may want to disable registration from within the TeamDrive Client.

If disabled, users must be created using the Registration Server API or a user import script as described in Importing Users via CSV Files. Another possibility is the use of an external authentication service that accesses an existing user repository such as an LDAP server or Active Directory (see External Authentication).

This setting may be used in PRE_LOGIN_SETTINGS.

enable-set-licensekey=true/false (default: true)

Enables/disables setting the license key in the client.

This setting may be used in CLIENT_SETTINGS.

enable-set-password=true/false (default: true)

Enables/disables the link to set a new password in the users profile page. Should be disabled in case that the Registration Server is configured to use external authentication. See also enable-lost-password.

This setting may be used in CLIENT_SETTINGS.

enable-space-webaccess (default: user-default)

Defines the default value for new created spaces, if access using the Web Portal is allowed or not.

Possible values are: true, false, user-default, user-false, user-true (user-false , user-true and user-default allows the user to change the value in the client; using just true or false cant be changed by the user and the menu entry to change enable-space-webaccess in the client will not be displayed in this case).

This setting may be used in CLIENT_SETTINGS.

enable-tdps=true/false (default: true)

You can disable the usage of a TDPS (TeamDrive Personal Server).

Note

Only the creation of Spaces using a TDPS is disabled. Accepting invitations to a Space which is located on a TDPS is always possible.

This setting may be used in CLIENT_SETTINGS.

enable-webdav=true/false (default: true)

You can disable the usage of a WebDAV server.

Note

Only the creation of Spaces using a WebDAV server is disabled. Accepting invitations to a Space which is located on a WebDAV server is always possible.

This setting may be used in CLIENT_SETTINGS.

enable-web-login=true/false/default (default: false)

“Web login” refers to the embedded browser-based login used for external authentication. If you wish Clients to use external authentication then you must set this setting to true. If both standard login (Registration Server based authentication) and web login are enabled then you can determine web login to be the default by setting this variable to default.

This setting may be used in PRE_LOGIN_SETTINGS.

enable-web-lost-password=true/false (default: false)

This enables the embedded browser-based lost password panel in the login dialogue. This allows you to directly connect the lost password functionality with an external authentication service (see Lost Password and Registration).

This setting may be used in PRE_LOGIN_SETTINGS.

enable-web-registration=true/false/default (default: false)

This variable is used to enable the embedded browser-based registration panel in the TeamDrive Client’s login dialogue. This may be desirable if you are using an external authentication system which allows user registration. In this case you must create a web-page which performs the registration as describe in External Authentication.

This setting may be used in PRE_LOGIN_SETTINGS.

fixed-provider-code=true/false (default: false)

If set to true, the Provider code as specified in the DISTRIBUTOR file will be used, and users will not be able to enter a Provider code on registration.

This setting may be used in PRE_LOGIN_SETTINGS.

hash-compare-files=true/false (default: false)

If set to false, TeamDrive will only use file size and the timestamp to detect new versions. Advantage: Scanning will be faster for spaces with big files. Disadvantage: New versions might be created in case that an application changes the timestamp without modifying the content of the file.

This setting may be used in CLIENT_SETTINGS.

inbox-url=URL

The URL for the inbox agent.

This setting may be used in CLIENT_SETTINGS.

inbox-user=username

The username for the inbox agent. The inbox functionality allows uploading files to a folder in a space without a client installation using an upload URL in a standard web browser. A TeamDrive Agent (version 4.3.0 or later required) must be installed with the inbox-user to accept the uploads. Folders can be secured with a password and/or limited by time or maximum amount of files. For more details about the inbox functionality please contact TeamDrive Systems.

Note

In case of using the email as username (see USER_IDENTIFICATION_METHOD) you have to use the magic username as inbox username.

This setting may be used in CLIENT_SETTINGS.

master-user=username

A single unique user name that will automatically be invited into every newly created Space with the MasterUserRights privilege (to automatically invite more than one user, use auto-invite-users=list). The user must already exist with at least one activated device.

Note

In case of using the email as username (see USER_IDENTIFICATION_METHOD) you have to use the magic username as master username.

This setting may be used in CLIENT_SETTINGS.

reg-name-complexity (default: basic-ascii)

The Registration Server supports UTF-8 characters for usernames. If you upload users via a CSV file or the Registration Server is connected to an external authentication system, it might be necessary to restrict the allowed characters.

You can assign these values:

  • basic-ascii (default): A-Z, a-z, 0-9, _, -, .
  • non-space-ascii: All ASCII characters between code 32 and 127 are allowed
  • printable-unicode: All printable characters as described here: http://qt-project.org/doc/qt-4.8/qchar.html#isPrint
  • all-unicode: All UTF-8 characters in the range between 0 and 65535.

If you use one of these values in the DISTRIBUTOR file and are using the Registration Server API, then you need to assign the same value for the API access (see REG_NAME_COMPLEXITY).

The characters ,, ;, @ and $ are reserved and may not be used in usernames.

This setting may be used in PRE_LOGIN_SETTINGS.

require-profile=true/false (default: false)

The “require-profile” setting will require users to enter certain profile related information during TeamDrive Client installation.

If a profile name is specified it will be displayed in place of the user’s username or registration email address in the TeamDrive Client.

This setting may be used in PRE_LOGIN_SETTINGS.

scan-enabled=true/false (default: true)

The internal database will be compared with the file system using a file system scan to detect Space changes while TeamDrive was not running.

This setting may be used in CLIENT_SETTINGS.

spaces-path

Default path for newly created Spaces by the user.

This setting may be used in CLIENT_SETTINGS.

require-provider-code=true/false (default: false)

Defines if entering a provider code is required.

This setting may be used in PRE_LOGIN_SETTINGS.