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 which are applied after login (multiple settings must each be placed on a new line).
- Client settings which are applied before login (multiple settings must each be placed on a new line).
The following TeamDrive Client settings can be adjusted:
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.
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.
enable-set-password=true/false (default: true)¶
Enables/disables the button to request a new password in the login dialogue. Should be disabled in case that the Registration Server is configured to use external authentication.
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.
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.
enable-registration=true/false/default (default: true)¶
The registration panel in the login dialogue that allows a user to create a new user account on the Registration Server. If user accounts are created by some other mechanism, then you may want to disable registration from within the TeamDrive Client.
If disabled, User accounts must be created using the Registration Server API or a user import script as described in Importing User Accounts 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).
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.
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.
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).
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).
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.
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.
require-provider-code=true/false (default: false)¶
Defines if entering a provider code is required.
fixed-provider-code=true/false (default: false)¶
Defines if the pre-defined provider code defined by code can be overridden.
enable-enterprise-server=true/false (default: true)¶
You can disable the usage of a Hosting Service.
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.
enable-tdps=true/false (default: true)¶
You can disable the usage of a TDPS (TeamDrive Personal Server).
Only the creation of Spaces using a TDPS is disabled. Accepting invitations to a Space which is located on a TDPS is always possible.
enable-webdav=true/false (default: true)¶
You can disable the usage of a WebDAV server.
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.
enable-import-server=true/false (default: true)¶
Defines whether WebDAV, TDPS or Host-Server Depot files can be imported into the client.
reg-name-complexity (default: basic-ascii)¶
The Registration Server supports all UTF-8 characters for an username. If the Registration Server is connected to an alternative authentication system it might be necessary to limit 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 characters
If you use one of these values in the DISTIBUTOR file and are using the Registration Server API, then you need to assign the same value for the API access (see REG_NAME_COMPLEXITY (<RegNameComplexity> tag)).
require-profile=true/false (default: false)¶
Once created, the TeamDrive username can not be changed. Users can delete their old accounts and create new ones, however, they will not be able not rejoin their previous Spaces without receiving a new invitation for each one of them.
If you want to use external authentication or import users from an external source (as described in chapter Importing User Accounts via CSV Files), you might want to use the username as a reference field for your system. This can be a database ID from your system. To avoid that this ID will be displayed in the TeamDrive Client as the username, you can set “require-profile” or “profile-uses-reg-email” to true. Users will fill in a personal user profile during the registration process. These profiles only exists within the client.
Space-specific profiles also exist for each Space in the normal TeamDrive Client. They can be used to define different profile data for each Space, however, they are optional.
The “require-profile” setting will require users to use the profile functionality from the beginning of the installation.
If the username field is being used to store a database ID, users must be allowed to log in with their email address as opposed to their username (which is unknown to them). Enable “allow-email-login” for this purpose.
sync-profile=true/false (default: false)¶
Each Space has his own user profile. By default the global profile will not be synced with the Space-specific profiles. If enabled, all profiles will be automatically synchronized.
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 the email field is not unique in TeamDrive. If the same email address is used by different accounts, the client will show a drop-down list of all possible accounts after the email address was entered.
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.
Default path for newly created Spaces by the user.
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.
auto-accept-invitation=true/false (default: false)¶
When set to true, the TeamDrive Client will accept all Space invitations automatically and join these Spaces.
auto-accept-invitation-mode (default: archived)¶
The mode of operation when joining Spaces automatically. Possible values are: current-version-only, all-versions, directory-information-only, no-sync-to-filesystem, offline-available, archived.
A list of user names to be automatically invited into newly created Spaces with specified DefaultInvitationRights. The list has to be separated by semicolons and enclosed with double quotes in the settings file. Example: auto-invite-users=”abc;def”
A single unique user name that will automatically be invited into every newly created Space with the MasterUserRights privilege. The user must already exist with at least one activated device.
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.
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.
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.
enable-key-repository=true/false (default: true)¶
Enable/disable the Key Repository.