Waarp Gateway

Waarp Gateway is an MFT solution with support for multiple protocols and provides interoperability between them. Gateway is typically used for protocol breaking.

Features

• Monitoring & traceability for all transfers
• Ability to execute pre & post tasks
• Make transfers both as a server and as a client
• Supports multiple databases: SQLite (embedded), PostgreSQL, MySQL and MariaDB
• Supports multiple protocols:
  • R66 / R66 over TLS
  • SFTP
  • HTTP / HTTPS
  • FTP / FTPS
  • PeSIT (currently in beta)
• Works in clusters with a load balancer
• Administration via a REST API & command line interface

Getting started

Installation with the pre-built packages

DEB, RPM and portable archives are available on our download site.

The installation documentation is available here.

With a container

You can start a container for Waarp Gateway with the command :

docker run code.waarp.fr:5000/apps/gateway/gateway:latest

The documentation to setup the container is available here.

Build from source

Waarp Gateway requires Go version 1.17 or later to compile. Since the Gateway also uses some C code, GCC (or Mingw on Windows) is also required on the machine to compile the program.

git clone https://code.waarp.fr/apps/gateway/gateway.git
cd gateway
./make.sh build

The binaries will be written in the build directory under the project's root directory. Note that this will only build the service and command line binaries, and only for the local machine's OS and architecture by default.

Cross-compilation can be achieved by setting the environment variables $GOOS and $GOARCH. For example to build binaries for windows, one can run (you might need to install the proper backends for GCC or Mingw according to the target architecture and OS):

GOOS=windows GOARCH=amd64 ./make.sh build

Run the tests

To run the classic test suite, run the following command:

./make.sh test

By default, this will run all the tests using SQLite as a test database. To run the tests with other types of database, set the $GATEWAY_TEST_DB environment variable to either postgresql or mysql and run the test command again. This requires a test database to be preconfigured on the local machine.

For PostgreSQL, the test database must be named waarp_gateway_test, and the server must be running on the default port (5432) with the default user enabled (user postgres with no password).

For MySQL, the database must also be named waarp_gateway_test, and the default MySQL user enabled (user root with no password) on the default port (3306).

Run the linters

Waarp Gateway uses the golangci-lint linter to check the code formatting and to check some for some basic coding errors. To run the linter, use the command:

./make check

Build the documentation

Note: Currently, the documentation for Waarp Gateway is only available in French.

The Waarp Gateway documentation is written in RestructuredText format, and built using the Sphinx documentation generator. As such, Python 3 and virtualenv are both required to build the documentation. Once these requirements are satisfied, run the following command to build the documentation:

./make.sh doc

The documentation will be written in HTML under the doc/build directory. Alternatively, you can use the command :

./make.sh doc watch

which will build the documentation, and then start a local HTTP server on port 8082 with the documentation hosted on it.

Support

Waarp provides professional support and services for Waarp Gateway.

License

Waarp Gateway is licensed under the terms of the GPLv3 License.

Links

• Download: dl.waarp.org
• Documentation: doc.waarp.org
• Forums: discuss.waarp.org
• Contact: [email protected]