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).
ACTIVATION Settings¶
ACTIVATION_ALLOWED_LANG¶
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.
ACTIVATION_DEFAULT_LANG¶
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¶
API_ADMINCONSOLE_LIC_REF¶
Value for the license reference column when creating licenses using the Administration Console.
API_ALLOW_CHECKSUMERR¶
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.
API_CREATE_DEFAULT_DEPOT¶
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.
API_CREATE_DEFAULT_LICENSE¶
By default each user will get a default license. You can disable this if you want the possibility of creating or assigning a license created by an API call.
API_IP_ACCESS¶
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.
API_REDIRECT¶
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.
API_REQUEST_LOGGING¶
Set to True
to enable logging of API requests in the API log. The value is
False
by default.
API_SEND_EMAIL¶
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
API_USER_NOT_ACTIVE_ACCESS_ALLOWED¶
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.
API_WEB_PORTAL_IP¶
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.
REG_NAME_COMPLEXITY¶
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).
AUTHSERVICE Settings¶
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.
lang
- The international language code of the current language of the client.
distr
- The Provider code in use by the client.
platf
- Specifies the platform of the client: mac, win, linux, ios, android or unknown.
size
- The size of the display area for the requested page: width x height in
pixels (e.g.:
400x500
). cookie
- This is the cookie stored by the client which was passed to the client after a successful external user authentication (see Login Procedure).
AUTH_CHANGE_EMAIL_URL¶
This URL points to the Change Email page of the external Authentication Service.
AUTH_LOGIN_URL¶
This URL points to the Login page of the external Authentication Service.
AUTH_LOST_PWD_URL¶
This URL points to the Lost Password page of the external Authentication Service.
AUTH_REGISTER_URL¶
This URL points to the Registration page of the external Authentication Service.
AUTH_VERIFY_PWD_FREQ¶
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.
USE_AUTH_SERVICE¶
Set to True
if you want to use an external Authentication Service.
VERIFY_AUTH_TOKEN_URL¶
This URL is used by the Registration Server to verify an Authentication Token, sent by the client after login using the Authentication Service.
BANNER Settings¶
The TeamDrive 3 client can display two different banners. One in the main window and one in the Space creation wizard.
The banner feature in the user’s license specifies whether a banner is displayed. A default banner will be shipped together with the installation package.
Banners can be updated using the Administration Console, see chapter Managing Banners in the Registration Server Administration Guide.
BANNER_ALLOWED_LANG¶
This is a comma separated list of allowed banner languages.
BANNER_DEFAULT_LANG¶
Banners depend on the chosen language of the user. If the language of the user is not supported, the default language will be used. This banner must always be available.
BANNER_ENABLED¶
Specifies whether the Banner update function of the Registration Server is enabled.
CLIENT Settings¶
ALLOWED_DIST_CODES¶
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.
Note
It is highly recommended that Provider always allows the standard TeamDrive Client (which has the TMDR code) in addition to any others.
CLIENT_NETWORKS¶
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.
CLIENT_SETTINGS¶
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.
ALLOW_EMAIL_CHANGE¶
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.
Note
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.
ALLOW_LOGIN_WITHOUT_EMAIL¶
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.
Note
The confirmation email should not be confused with the activation email which is always sent when a user registers for the first time.
ALLOW_NEW_REGISTRATION¶
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.
Note
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.
ALLOW_PASSWORD_CHANGE¶
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.
Note
This is a server-side setting only, if you set it to False
you need to add
enable-set-password=false
to the CLIENT/PRE_LOGIN_SETTINGS
provider setting.
See chapter enable-set-password=true/false (default: true) for details.
EXT_USER_REFERENCE_UNIQUE¶
Set to True
if the user’s external reference column must be unique.
FREE_LIMIT_SIZE¶
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.
MINIMUM_CLIENT_VERSION¶
Any clients with a version below this may not register a new device. The default is 3.0.0.000. For setting up a new server you might increase the minimum client version to 4.0.0.000 if you want to support only version 4 clients.
PRE_LOGIN_SETTINGS¶
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.
USE_EMAIL_AS_REFERENCE¶
Enable if you want to use the email address to reference your users between your own system and the Registration Server. In this case usernames will be automatically generated when using the API. All further API requests which require the username can then use the email instead.
CSVIMPORT Settings¶
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.
CSV_ALLOW_SET_DEPARTMENT¶
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.
CSV_IDENTITY_COLUMN¶
This setting specifies which column will be used to identify a user in the CSV import. Valid options are: username, email, reference and authid.
CSV_IMPORT_ACTIVE¶
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.
CSV_USE_FILESYSTEM¶
Enable this setting to use a hotfolder for importing CSV files.
DISABLE_MISSING_CSV_USERS¶
This value will control, whether users not present in the CSV file will be disabled.
The additional “department” column must be filled in the CSV file. Username and department must match the existing record in the database.
EMAIL Settings¶
BRAND_NAME¶
The brand name that is substituted for [[BRAND]]
in e-mail templates. If
not set, the default TeamDrive
will be used.
EMAIL_ALLOWED_LANG¶
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.
EMAIL_DEFAULT_LANG¶
If the user is using a language which is not listed in
<AllowedEmailLanguage>
, the <DefaultEmailLanguage>
will be used
instead.
EMAIL_REPLYTO¶
This address will be used for invitation mails. Its usage depends on the value
in USE_EMAIL_SENDER_EMAIL
.
EMAIL_SENDER_EMAIL¶
The activation mail will list this email address as the sender.
USE_SENDER_EMAIL¶
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.
HOSTSERVER Settings¶
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.
API_USE_SSL_FOR_HOST¶
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
.
AUTO_DISTRIBUTE_DEPOT¶
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.
HAS_DEFAULT_DEPOT¶
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
.
HOST_DEPOT_SIZE¶
The size of the default depot for the user in bytes. Default is:
2 GB = 2147483648 Bytes
HOST_SERVER_NAME¶
Please choose a Host Server from the list to use as the default depot server for new clients.
HOST_SERVER_URL¶
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.
HOST_TRAFFIC_SIZE¶
The monthly allowed traffic for the user in bytes.
Default is: 20 GB = 21474836480 Bytes
LICENSE Settings¶
ALLOW_CREATE_LICENSE¶
Set to True
to allow the creation of licenses for this provider. This
setting can only be changed by the Default Provider.
ALLOW_MANAGE_LICENSE¶
Set to True
to allow the management of licenses for this provider. This
setting can only be changed by the Default Provider.
CLIENT_DEFAULTLICREF¶
License reference value for default licenses.
DEFAULT_FREE_FEATURE¶
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:
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).
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.
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).
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.
This feature enables restrictions that are specified using certain client settings. The only setting currently effected by this feature is Theactive-spaces-limit
setting. This setting can be specified inCLIENT_SETTINGS
Provider setting. When specified, it only applies if the Restricted Client feature is set.
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.
DEFAULT_LICENSEKEY¶
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.
ENABLE_LICENSE_EXPIRY¶
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.
PROFESSIONAL_TRIAL_PERIOD¶
This is the number of days for the one-off professional trial period, set to 0 if no trial is allowed.
LOGIN Settings¶
LOGIN_IP¶
A comma-separated list of IP addresses allowed to login to the Administration Console.
LOGIN_TWO_FACTOR_AUTH¶
Set to True
to enable two-factor authentication via email for logging into
the Administration Console.
REDIRECT Settings¶
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:
[lang]
- The international language code of the current language of the client.
[user]
- Base 64 encoded username. This variable is only supplied for the
REDIRECT_PURCHASE
URL. [product]
- Specifies the product ordered. Only provided for the
REDIRECT_ORDER
URL. Currently the only possible value is TDPS.
REDIRECT_ALLOWED_LANG¶
A list of allowed languages for the redirector pages.
REDIRECT_DEFAULT_LANG¶
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.
REDIRECT_DOWNLOAD¶
This URL redirects to a page where the Provider’s version of TeamDrive can be downloaded.
REDIRECT_FAQ¶
This URL redirects to the Provider’s FAQ (frequently asked questions) page.
REDIRECT_FORUM¶
This URL redirects to the Provider’s forum page.
REDIRECT_HELP¶
This URL redirects to the Provider’s help page.
REDIRECT_HOME¶
This URL redirects to the Provider’s home page.
REDIRECT_ORDER¶
This URL redirects to the Provider’s product order page. The variable
[product]
can currently only be ‘TDPS’.
REDIRECT_PROVIDERINFO¶
This URL redirects to a Provider information page which describes all available Provider codes which may be used during registration.
REDIRECT_PURCHASE¶
This URL redirects to the Provider’s page for purchases licenses. The variable
[user]
is a base 64 encoded username.
REDIRECT_TUTORIALS¶
This URL redirects to the Provider’s tutorials page.
REDIRECT_USERINVITEUSER¶
This URL redirects to the Provider’s user-invite-user
page.
REFERRAL Settings¶
You can configure a referral program as an incentive for users to invite other users in order to increase their free storage limit.
Note
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).
MAX_PROMOTION_USER¶
The maximum amount of new users which can be invited by an existing user.
PROMOTION_UPGRADE¶
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.
TDNS_CHECKSUMKEY¶
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).
TDNS_SERVERID¶
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.
UPDATE_ALLOWED_LANG¶
A comma separated list of allowed languages.
UPDATE_DEFAULT_LANG¶
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.
UPDATE_TEST_USER¶
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.