Synopsis¶
teamdrived [options] (autostart | shutdown)
Options¶
This is a list of known settings or command line arguments that are used by TeamDrive.
Local Installation Settings¶
-
--spaces-path
¶
Default path for newly created Spaces by the user.
Note
On Windows, this path may not contain backslashes. Please use slashes instead like this:
C:/Path/to/Spaces
.
-
--teamdrive-home
¶
Set TeamDrive application data path. Typically
~/.teamdrive
on Linux or Mac OS and%APPDATA%\TeamDrive3
on Windows.Note
On Windows, this path may not contain backslashes. Please use slashes instead like this:
teamdrive-home=C:/Path/to/Appdata
.
-
--data-path
¶
Default location for temporary data and cache files. Defaults to
teamdrived --teamdrive-home
Note
On Windows, this path may not contain backslashes. Please use slashes instead like this:
data-path=C:/Path/to/TeamDrive Data
.
-
--default-server
¶
Default host server to create spaces on
-
--perform-backup
=true/false (default: true)
¶ Enable / Disable creation of Backups
-
--backup-path
¶
Set the Backup path
Note
On Windows, this path may not contain backslashes. Please use slashes instead like this:
backup-path=C:/Path/to/Backups
.
-
--language
¶
Set the user interface language. This setting is deprecated.
Deprecated since version 4.1.3.
-
--autostart-delay
¶
Delay background tasks to speedup system startup time
-
--working-set-size
¶
Maximum cache size
-
--enable-folder-decoration
=true/false (default: true)
¶ Enable / Disable file system folder decoration
-
--enable-create-favorite-link-to-spaces
=true/false (default: true)
¶ Windows only: creates a shortcut in the Windows explorer favorites to the
teamdrived --spaces-path
folder.
-
--device
=<device>
¶ if device is “softwarecontext”, TeamDrive will use the QtQuick2dRenderer as the rendering backend (Windows only)
-
--enable-multi-processes
=true/false (default: false)
¶ Allow spawning of multiple TeamDrive instances.
-
--enable-shell-extension
=true/false (default: true)
¶ Enables or disables the Windows Explorer integration or the Finder Extension.
New in version 4.1.2.
-
autostart
¶
Don’t show the main window.
-
shutdown
¶
Shutdown the currently running TeamDrive process.
-
webgui
¶
Lauches TeamDrive with a WebGUI instead of the normal user interface.
Note
Desktop only.
Registration Server Communication¶
-
--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.
-
--auto-invite-users
=list
¶ 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”
-
--enable-key-repository
=true/false (default: true)
¶ Enable / Disable the Key Repository.
Synchronization Settings¶
-
--default-file-permissions
¶
Default unix file permissions. Default is 644.
-
--default-dir-permissions
¶
Default unix directory permissions. Default is 755.
-
--scan-enabled
=true/false (default: true)
¶ On startup, the internal database will be compared with the file system using a file system scan to detect Space changes while TeamDrive was not running.
-
--default-publish-expiry-days
(default: 0)
¶ Default value for the number of days, a file is published. Requires a HostServer Version >=
3.5
. A value of0
means unlimited.
Agent Settings¶
-
--http-api-port
=<host>
¶ where <host> equals one of the following:
- a port number (e.g.
45454
) - an IPv4 address including the port number (e.g.
127.0.0.1:45454
) - an IPv6 address including the port number (e.g.
[::0]:45454
) - a pipe or socket name. Requires
http-api-type=local
. - a pipe or socket name. Requires
http-api-type=local
.
- a port number (e.g.
-
--http-api-type
¶
Sets the type of the HTTP API.
local
: Opens a Named pipe on Windows or a Socket file on Linuxtcp
: Opens a TCP port.ssl
: Opens a SSL/TLS encrypted TCP socket. Seeteamdrived --http-api-private-key
andteamdrived --http-api-certificate
-
--http-api-certificate
¶
SSL-Server only: A path to a certificate file for the api (PEM format).
Note
On Windows, this path may not contain backslashes. Please use slashes instead like this:
http-api-certificate=C:/Path/to/Certificate.pem
.
-
--http-api-private-key
¶
SSL-Server only: A path to a RSA private file for the certificate (PEM format). See also
teamdrived --http-api-certificate
.Note
On Windows, this path may not contain backslashes. Please use slashes instead like this:
http-api-private-key=C:/Path/to/Key.key
.
-
--idle-shutdown-timeout
¶
The number of idle seconds, until the TeamDrive Agent shuts itself down. Typically used with automatically shutdown of Linux containers. Default: no timeout.
New in version 4.1.1.
-
--http-api-external-register-url
¶
This url will be used to show a “Register Now” link in the Web UI. This setting is mainly useful for Web Portals.
New in version 4.1.1.
-
--http-api-external-login-url
¶
This url will be used to redirect the Browser if a login is required. This setting is intended to be used for external authentication.
New in version 4.1.1.
-
--http-api-compress-replies
=true/false (default: true)
¶ Use a zipped HTTP content-encoding for JSON replies.
New in version 4.1.1.
Platform specific Settings¶
It is possible to limit a setting to a specific domain. For example if you add -linux to a setting, this setting will only affect Linux clients.
Suffix | Description |
---|---|
-mac | Mac OS X only. |
-win | Windows only. |
-linux | Linux Clients only. |
-agent | Used by the Headless Agent. |
Configuration Files¶
TeamDrive reads settings from these locations:
- Program arguments as mentioned above.
- The read-only
DISTRBIBUTOR
file in the application installation path, eg.C:\Program files\TeamDrive\DISTRIBUTOR
or/opt/teamdrive/DISTRIBUTOR
. - A system wide configuraion file. Windows:
%ProgramData%\TeamDrive3\teamdrive.ini
, Linux:/etc/teamdrive.ini
, Mac OS:/Users/Shared/teamdrive.ini
. - The
teamdrive.settings
file in the application data directory, eg.teamdrived --teamdrive-home
. Typically~/.teamdrive
on Linux or Mac OS and%APPDATA%\TeamDrive3
on Windows. - The Registration Server may also provide some of these settings. Please consult the Registration Server documentation for details.
The majority of arguments can also be added to [Settings] Section of the configuraion files.
This is a valid teamdrive.settings
file that sets two settings on Linux:
[Settings]
language=en-US
spaces-path=/home/teamdrive/Spaces
And this is the corresponding settings file for Windows:
[Settings]
language=en-US
spaces-path=C:/Users/TeamDrive/Documents/Spaces
Please note the usage of forward slashes instead of backslashes on Windows. Also notice that a
setting in the teamdrive.settings
file is not prefixed by two dashes (--
).