diff --git a/Home.md b/Home.md index 93a012c..a7b64b0 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,37 @@ -# Deploy the Project on CamelX Platform +# FTPS Sink -Deploy on CamelX Platform in three steps +Send data to an FTPS server. -## Step 1: Create a release -From the project space, click on **"Create a release"** +In the header, you can set the `file` / `ce-file` property to specify the filename to upload. -The new version is automatically available in the list +If you do not set the property in the header, the Kamelet uses the exchange ID for the filename. -## Step 2: Deploy -Click on **"Deploy"** +## Metadata -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Property | Value | +|----------|-------| +| Type | sink | +| Group | FTP | +| Namespace | File | +| Support Level | Stable | +| Provider | Apache Software Foundation | -## Step 3: Expose -Enable **"Expose"** +## Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `connectionHost` | string | ✓ | | The hostname of the FTP server. | +| `connectionPort` | string | ✓ | `21` | The port of the FTP server. | +| `username` | string | ✓ | | The username to access the FTP server. | +| `password` | string | ✓ | | The password to access the FTP server. | +| `directoryName` | string | ✓ | | The starting directory. | +| `passiveMode` | boolean | | `false` | Set the passive mode connection. | +| `fileExist` | string | | `Override` | Specifies how the Kamelet behaves if the file already exists. | +| `binary` | boolean | | `false` | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | +| `autoCreate` | boolean | | `true` | Automatically create the directory the files should be written to. | + +## Dependencies + +- `camel:ftp` +- `camel:core` +- `camel:kamelet`