Synopsis

teamdrived [options] (autostart | shutdown)

Options

This is a list of known settings or command line arguments that are used by TeamDrive.

The majority of these settings can also be added to [Settings] Section of , the teamdrive.settings file located in the teamdrived --teamdrive-home folder, which typically ~/.teamdrive on Linux or Mac OS and %APPDATA%\TeamDrive3 on Windows.

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 slashes instead of backslashes on Windows. Also notice that a setting in the teamdrive.settings file is not prefixed by two dashes (--).

Local Installation Settings

--spaces-path

Default path for newly created Spaces by the user.

--teamdrive-home

Set TeamDrive application data path. Typically ~/.teamdrive on Linux or Mac OS and %APPDATA%\TeamDrive3 on Windows.

--data-path

Default location for temporary data and cache files. Defaults to teamdrived --teamdrive-home

--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

--language

Set the user interface language

--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

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.

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.

Agent Settings

--http-api-port=<host>

where <host> equals one of the following:

  1. a port number (e.g. 45454)
  2. an IPv4 address including the port number (e.g. 127.0.0.1:45454)
  3. an IPv6 address including the port number (e.g. [::0]:45454)
  4. a pipe or socket name. Requires http-api-type=local.
--http-api-type

Sets the type of the HTTP API.

  1. local: Opens a Named pipe on Windows or a Socket file on Linux
  2. tcp: Opens a TCP port.
  3. ssl: Opens a SSL/TLS encrypted TCP socket. See teamdrived --http-api-private-key and teamdrived --http-api-certificate
--http-api-certificate

SSL-Server only: A path to a certificate file for the api (PEM format).

--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.

--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.