############ Introduction ############ This manual will guide you through the installation of your TeamDrive Agent. This document is intended for system administrators and user who need to install and configure a TeamDrive Agent. This Installation Guide outlines the deployment of a stand alone TeamDrive Agent which is not part of a Web Portal. Overwiew -------- The TeamDrive Agent is a full featured TeamDrive Client without a graphical user interface. An Agent provides: * Synchronization of Spaces with the Cloud. * Synchronization of Spaces with a local file system. * Synchronization of Spaces with a remote file system. * Management GUIO using a Web App. * API access using JOSN calls. This figure shows an overview of a TeamDrive Agent installation: .. image:: TD_Agent.png Typically, a TeamDrive Agent is installed on a server or a network attached storage and communicates to the TeamDrive Cloud. #################### Windows Installation #################### Requirements ------------ The *TeamDrive Agent* allows a TeamDrive Windows client to be installed and run as a service. The *TeamDrive Agent* can be run without a GUI and allows data to be synchronized in the background, even when a Windows user is not currently logged in. Installation ------------ #. During the installation the *TeamDrive Agent* will be registered as a Windows service under the name “\ *TeamDrive Agent Client*\ ”. Please be aware that the Windows user logged in at the time of the *TeamDrive Agent Client’s* installation is automatically associated with this Windows service. Only this Windows user will be able to access the settings file of the *TeamDrive Agent*. #. Open the Windows services overview (e.g. on Windows 8 “Control Panel” → “Administrative Tools” → “Services”). #. Start the service “\ *TeamDrive Agent*\ ”. Your TeamDrive Spaces will now be synchronized in the background. Changing the Windows User Account --------------------------------- If at some point you wish to change which Windows user you would like to use to manage the *TeamDrive Agent*, you simply need to edit a configuration file “teamdrive.ini”. You can navigate to the file using “%programdata%” → “TeamDrive3” → “teamdrive.ini” or simply “C:\\ProgramData\\TeamDrive3\\teamdrive.ini”. Open the file with a text editor, locate the entry “teamdrive-home-agent=” and replace the old Windows user account with the new desired Windows user account in the given file path. Here is an example of what you should see: “teamdrive-home-agent=C:/Users/**Windows User Account Name**/AppData/Roaming/TeamDrive3”. Afterwards, you can continue from **Step 2** of the section **Installation**. Accessing Network Shares ------------------------ In order to access Spaces on network shares, the Windows account needs to be changed to a user who has rights to access network shares. It is recommended to use the Windows account, that is used to start the Desktop GUI. .. note:: the *TeamDrive Agent* running as a Windows Services may not be able to access mapped network dries. It is recommended to use a *UNC* path directly as a Space root. ################## Linux Installation ################## At the moment, you can either use the 64 bit RPM package or the 64 bit .tar.gz file. Requirements ------------ The Library Dependencies are moderate and should be provided by all recent linux distributions: ======= ======= Library Version ======= ======= GLibc 2.9 GLibc++ 3.4.11 libz ======= ======= Under Linux, TeamDrive is using the inotify [#inotify]_ API of the Linux kernel to be notified about file modifications. Under some Linux distributions, there is a rather small limit regarding the number of files that can be watched. You can find out the current watch handle limit by executing :code:`cat /proc/sys/fs/inotify/max_user_watches` in a terminal. If this number is lower than the number of files in your Spaces, please increase this value by adding for example :code:`fs.inotify.max_user_watches=100000` to your `/etc/sysctl.conf` file. Please reboot your system afterwards. .. [#inotify] http://man7.org/linux/man-pages/man7/inotify.7.html Installation on RPM based Distributions --------------------------------------- If you are on a RPM based distribution, please install the TeamDrive Agent by insalling the rpm file. The TeamDrive Agent is hosted on a dedicated yum repository. This makes the installation and applying of future updates very easy — you can simply run yum update to keep your TeamDrive Agent up to date. To enable the repository, you need to download the td-agent.repo file and place it into the directory /etc/yum.repos.d/, e.g. by using wget:: [root@agent ~]# wget -O /etc/yum.repos.d/td-agent.repo \ http://repo.teamdrive.net/td-agent.repo This will enable the “TeamDrive Agent Version 4” repository, which you can check by running yum repolist afterwards:: [root@agent ~]# yum repolist Loaded plugins: security repo id repo name status td-agent-4 TeamDrive Agent Version 4 4 base CentOS-6 - Base 6.367 extras CentOS-6 - Extras 14 updates CentOS-6 - Updates 1.094 repolist: 7.477 To install the TeamDrive Agent, install the following package via yum from the “TeamDrive Agent” repository:: [root@agent ~]# yum install teamdrive-Agent Please contingue with :ref:`starting-and-stopping`. Installation on other Distributions ----------------------------------- To install the TeamDrive Agent on a non-RPM based distribution, please download the Agent manually for example by using wget:: wget http://s3download.teamdrive.net.s3.amazonaws.com/4./TMDR/linux-x86_64/TeamDrive_Agent_4._x86_64.tar.gz Please replace `` with the latest release. Now, please extract the *TeamDrive Agent*:: tar -xvzf TeamDrive_Agent_4._x86_64.tar.gz This will extract the TeamDrive Agent into a subdirectory `TeamDrive`. .. note:: The `tar.gz` file does not register a `teamdrive-Agent` comman on your system. .. _starting-and-stopping: Starting and Stopping --------------------- Before starting the TeamDrive Agent for the first time, please also read :ref:`initial-set-up`. Please start TeamDrive by using the shortcut in your desktop menu or bar. Alternatively, you can execute the global command "teamdrive-Agent" or "./teamdrived" from the installation folder. TeamDrive requires some system settings that are not available by executing the teamdrived.bin executable directly. .. note:: Running TeamDrive as root is not recommended. TeamDrive runs perfectly without previliges. To stop the TeamDrive Agent, please execute:: /opt/teamdrive/TeamDriveApi.py ':' quit False Replace `` with the host where your TeamDrive Agent is installed and the port with the one you spicified. .. _initial-set-up: ############## Initial Set-Up ############## To administrate your TeamDrive Agent, you need to enable the HTTP API by setting the :option:`teamdrived --http-api-port` option either as a command line argument or as a setting. Then start the TeamDrive Agent, open your favorite browser and go to `http://:45454`. Replace `` with the host where your TeamDrive Agent is installed and the port with the one you spicified. Log-in to your TeamDrive account now. ######################### Performance Consideration ######################### The TeamDrive Agent is typically used to synchronize data on a central server. These are some guidelines to optimize the performance of the TeamDrive Agent in this situation: #. Do not mount the file system over the network, which contains the data that will be synchronized. Network shares are much slower than local file systems. Using a network share will limit the number of files and directories per Space. #. Use more than one TeamDrive Space. Using more than one Space can increase the performance. For example, you could have one Space per project or team. ########################### Migrating from TeamDrive 3 ########################### The application data directory (spicified by the :option:`teamdrived --teamdrive-home` parameter) is compatible to TeamDrive 3. #. Performa a full system backup in order to be able to restore your system if you encounter unexpected errors. #. Shutdown the TeamDrive 3 Agent. #. Install the new TeamDrive 4 Agent as described, but do not start the TeamDrive Agent. #. Make sure that you have only one installation of the TeamDrive Agent. Manually delete older TeamDrive 3 installations in case they are not automatically deleted. #. Start the TeamDrive 4 Agent. See :ref:`initial-set-up`. .. warning:: On Windows, the `uninstall.exe` will delete the application data directory. Be careful when removing old installations.