SFTP Gateway Deployments

The UI provides an SFTP Gateway deployment menu that enables users to create a new SFTP Gateway. The page shows a list of all deployments, including both active and deleted ones.

To add a new SFTP Gateway, users are required to provide the following information:

• Instance Name: A name for the SFTP deployment. This name helps identify and distinguish the deployment from others.
• Version: The version of the SFTP Gateway. We continuously improve and add new features to our SFTP Gateway. Use the latest recommended version.
• Ingress External Port: The port where the SFTP Gateway will accept requests. We recommend using port 22, 80, or 8080.
• Username and Password: The username and password used to authenticate to the SFTP Gateway.
• Public Port: A public port for the SFTP Gateway deployment. This port allows external access to the SFTP Gateway.
• Keys: The keys associated with the SFTP deployment. These keys are used for authentication and secure file transfer.
• Upload Destination: The destination for the SFTP deployment. These destinations determine where the files will be transferred.

API Gateway Uploader Deployments

The UI provides an API Gateway Uploader deployment menu that enables users to create a new API Gateway. The page shows a list of all deployments, including both active and deleted ones.

To add a new API Gateway Uploader, users are required to provide the following information:

• Instance Name: A name for the API Gateway deployment. This name helps identify and distinguish the deployment from others.
• Upload Destination: The destination for the API Gateway deployment. These destinations determine where the files will be transferred.

Destinations

The Destinations page in the UI allows users to view and manage destinations. Users can see a list of defined destinations and have the option to add a new destination.

To add a new destination, users are required to provide the following information:

• Alias: An alias for the destination. This alias helps identify and label the destination for easy reference.
• Destination Type: The type of destination, which could be a specific protocol or service used for file transfer or storage.
• Host and IP: The hostname or the IP address of the destination. This information helps establish a secure connection to the destination.
• Credentials: Either a username and password or SSH public keys as credentials for the upload system to access the destination securely.

Keys

The Keys page in the UI allows users to manage and view all the keys stored in the system. Users can see a list of existing keys and have the ability to add a new key.

To add a new key, users are required to provide the following information:

• Alias: An alias for the key. This alias helps identify and label the key for easy reference and management.
• Public SSH Key: The public SSH key itself (e.g., cat ~/.ssh/id_rsa.pub | pbcopy). This key is used for authentication and secure access to the SFTP Gateway.

API

The Public API Endpoints provide a set of interfaces that enable automation of tasks within the system. These endpoints are designed to be accessible by external systems such as Jenkins pipelines or Azure DevOps pipelines, allowing seamless integration and automation capabilities.

Users can interact with the endpoints to perform various tasks, such as initiating deployments, retrieving deployment status, managing configurations, and more.

Connectors

The Connectors page provides a set of interfaces to various services for sending notifications. In case of a failed data transfer, the user can receive a notification message via the configured connector using webhooks.

Notifications

The Notifications page serves as a central hub for users to access a consolidated stream of events dispatched by the notification system.

Within this interface, each notification provides a thorough and detailed explanation of why a data transfer did not complete as expected.

Users

The User Management page provides a comprehensive interface for managing users within the system. Users with the appropriate permissions can access this page to view and manage the list of existing users.

Based on the subscription type, the owner has the ability to invite additional users and extend the system's capabilities to a broader team. Invited users will have similar privileges and be able to perform various tasks, including creating deployments, managing destinations, and more.

To invite a new user, the system requires the following information:

• Login name
• User's name and surname
• Email address
• Job title

By providing these details, the system can generate an invitation and grant the invited user access to the system's functionalities.

Subscriptions

The Subscriptions page allows the owner of the application to manage the subscription settings.

Upon the user's initial login, the application's functionality will be restricted until a subscription is purchased.

To complete the subscription process, the user will need to provide necessary information such as their address and VAT number.

The subscription information can be managed by the user at any time, allowing them to update or modify their details as needed.

Additionally, the Subscriptions page provides access to a history of invoices and receipts, enabling users to review past transactions and obtain relevant financial records.