Documentation de Waarp Transfer
===============================

:Version: |version|
:Date:    |today|

Waarp Transfer est moniteur de transferts (MFT) pour le protocole R66.

Optimisé pour gérer des volumes massifs de fichiers, il assure l'intégrité de
tous les fichiers transférés tout en offrant une garantie d'acheminement.

Ses principales fonctionnalités sont :

- Mode :ref:`serveur <ref-cli-server-server>`, :ref:`client <client-send-receive-files>`, ou :ref:`filewatcher
  <client-filewatcher>`
- Connexions TLS
- Transferts :ref:`synchrones <client-send-receive-files>` ou :ref:`asynchrones <user-add-transfer>`
- Reprise de transferts
- Possibilité de :ref:`programmer des transferts <user-add-transfer>`
- Définition de :ref:`chaînes de traitements <user-add-rule>` pré-transfert,
  post-transfert, et en cas d'erreur
- Vérification d'intégrité de bout en bout ou par bloc
- Multiplexing de connexions
- Fonctionne en :ref:`grappe haute disponibilité <reference-conf-override>`
- :ref:`API REST <reference-rest-api>` de gestion et d'administration
- Client d'administration en ligne de commande local ou à distance

Cette documentation contient plusieurs sections.

La première vous accompagne dans l'installation de l'application :

.. toctree::
   :caption: Guide d'installation
   :maxdepth: 1

   installation/requirements
   installation/install

.. toctree::
   :caption: Premiers pas
   :maxdepth: 1

   getting-started/intro
   getting-started/start
   getting-started/folders
   getting-started/r66-send
   getting-started/r66-recv
   getting-started/watcher
   getting-started/cluster

Le guide utilisateur décrit le fonctionnement de Waarp Transfer :

.. toctree::
   :caption: Guide utilisateur
   :maxdepth: 1

   user/cli/administration/index
   user/cli/client/index

La section suivante contient plusieurs page ayant trait à l'administration et à
l'exploitation de l'application :

.. toctree::
   :caption: Guide administrateur
   :maxdepth: 1

   administration/usage
   administration/service
   administration/backup
   administration/purge

La dernière section présente la référence des diverses commandes et paramètres
de l'application.

.. toctree::
   :caption: Référence
   :maxdepth: 1

   reference/cli/index
   reference/configuration
   reference/filewatcher
   reference/override
   reference/rest/index
   reference/container
   reference/protocols/index
   reference/proto_config/index
   reference/tasks/index
   reference/cloud/index
   reference/errorcodes
   reference/backup
   reference/snmp

.. toctree::
   :caption: Annexes
   :maxdepth: 1

   changelog
   glossary
   genindex
