.. index::
   single: Waarp Gateway FTP
   single: FTP

Waarp Gateway FTP
=================

.. contents::

Waarp Gateway FTP enables interoperability between the R66 and FTP
protocols: it is both an FTP server ad a R66 client.

It provides an interface to FTP clients that allows them:

- To fetch files at their disposal;
- To deposit files, that will be automatically forwarded to other R66
  instances

To interract fully with the whole transfer infrastructure, it is
associated with a server Waarp R66  with the same identifier
(``hostid``).


Directory Used
--------------

Waarp Gateway FTP instances uses the following directories (where
``{hostid}`` is used for the identifier of the instance):

:file:`/etc/waarp/conf.d/{hostid}`
  Contains the XML configuration files for the instance (and for the
  associated Waarp R66 Server)

:file:`/var/lib/waarp/{hostid}/ftp`

  Root of user directories for all FTP clients. the tree has two levels,
  ``{username}/{account}``, where ``username`` is the login setup for
  the  FTP client and ``{account}`` is one of the account setup for the
  user. A FTP client can only put and get files in the subtree
  corresponding to its login.


Commands
--------

Waarp Gateway FTP can be started and stopped with the system service
manager:

.. code-block:: bash

   service waarp-gwftp {start|stop|status|restart} [hostid|all]


For example, the following command starts the gateway ``gwftp`` :

.. code-block:: bash

  service waarp-gwftp start gwftp

If no instance identifier (``hostid``) is given, the action only affects
the instances  configured to be automatically started and stopped. If
the keyword ``all`` is used, *all* the configured instances are
affected.

In addition, the command :program:`waarp-gwftp` can handle some
operations that are specific to Waarp R66 servers. The available
subcommands are :


- ``initdb``: Initialize the database
- ``help``: Show a help message

The command :program:`waarp-gwftp` must be followed by the
identifier of the wanted instance.


For example, the following command initialize the database of the
instance ``gwftp`` :

.. code-block:: bash

   waarp-gwftp gwftp initdb