Update wiki Home page for sftp-sink

gitea_admin 2026-03-11 14:40:07 +00:00
parent 39c66e355b
commit 5198b44426

49
Home.md

@ -1,21 +1,42 @@
# Deploy the Project on CamelX Platform
# SFTP Sink
Deploy on CamelX Platform in three steps
Send data to an SFTP 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 | ✓ | `22` | 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` | Specifies to use passive mode connection. |
| `fileExist` | string | | `Override` | How to behave in case of file already existent. |
| `binary` | boolean | | `false` | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). |
| `privateKeyFile` | string | | | Set the private key file so that the SFTP endpoint can do private key verification. |
| `privateKeyPassphrase` | string | | | Set the private key file passphrase so that the SFTP endpoint can do private key verification. |
| `privateKeyUri` | string | | | Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification. |
| `strictHostKeyChecking` | string | | `no` | Sets whether to use strict host key checking. |
| `useUserKnownHostsFile` | boolean | | `true` | If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts. |
| `autoCreate` | boolean | | `true` | Automatically create the directory the files should be written to. |
## Dependencies
- `camel:ftp`
- `camel:core`
- `camel:kamelet`