How to use CompleteAgent

Overview

CompleteAgent is a cross-platform client that is designed to perform robust, automatic uploads to CompleteFTP. CompleteAgent can run as a standalone application on Windows and Linux, but on Windows is typically run as a service. It monitors a designated folder for new files and securely uploads them to a specified CompleteFTP server when they appear.

Requirements

CompleteAgent is a free client application that requires an Enterprise Edition CompleteFTP server to connect to. It can be freely installed on any machine. As well as being a Windows service, CompleteAgent includes a .NET standard binary that can be run on any platform (including Linux) that supports .NET standard.

Installation

CompleteAgent is installed as part of the CompleteFTP trial, and is optionally installed by the production installer. In both cases, it is installed as a Windows service, but only the trial starts the service running.

CompleteAgent requires user credentials to connect to the user - the trial creates a user called completeAgent, and sets up a private key, so that it is ready to go once the trial is installed.

Configuration

By default, CompleteAgent is installed in a subdirectory of the main CompleteFTP installation directory, called CompleteAgent. Typically then, it can be found at C:\Program Files (x86)\Complete FTP\CompleteAgent. The Windows-specific binaries are found in the net subdirectory, while the cross-platform .NET standard binaries are found in standard.

The main configuration file for CompleteAgent is found at C:\ProgramData\Enterprise Distributed Technologies\CompleteAgent\CompleteAgent.ini. The various options that can be set in the configuration file are also available as command-line options if the binary is run from the command-line rather than as a service. The long names of the command-line options are the same names used in the configuration file.

Command-line options

Although CompleteAgent is installed as a Windows service, it can also be run from the command-line - and installed as a service from the command-line.

            install - install CompleteAgent as a Windows service
            uninstall - uninstall the CompleteAgent service
            start - start the CompleteAgent service
            stop - stop the CompleteAgent service
        

The options below are used when running CompleteAgent from the command-line.

        	-rd or -RootDirectoryPath - the base directory under which all files and directories will be placed by default - defaults to C:\ProgramData\Enterprise Distributed Technologies\CompleteAgent
        	-s or -ServerAddress - IP address or host-name of server
        	-sp or -ServerPort - server port - defaults to 22
        	-u or -UserName - user-name of account on server
        	-p or -Password - password of account on server
        	-kf or -PrivateKeyFilePath - path of private key file to use
        	-kp or -PrivateKeyPassword - password for private key file
        	-d or -ServerDirectory - directory to use on server - defaults to user's home directory
        	-l or -LogLevel - logging level (All, Debug, Information, Warning, Error) - defaults to Information
        	-h or -help - show help for most important options
        	-hh - show help for all options	
        

Using CompleteAgent

By default, CompleteAgent is configured to detect files being placed in C:\ProgramData\Enterprise Distributed Technologies\CompleteAgent\Uploads. Once files are placed here, they are securely uploaded to the location specified in the configuration, using the named user and their credentials.

Successfully uploaded files are moved to the C:\ProgramData\Enterprise Distributed Technologies\CompleteAgent\Completed. If an upload fails, the file is eventually moved to C:\ProgramData\Enterprise Distributed Technologies\CompleteAgent\Failed. Diagnostic information on the failure can be found in the logs, which are written to C:\ProgramData\Enterprise Distributed Technologies\CompleteAgent\Logs.