Update wiki Home page for sftp-source

gitea_admin 2026-03-11 14:40:09 +00:00
parent f8da2d272f
commit 53ea5667a0

48
Home.md

@ -1,21 +1,41 @@
# Deploy the Project on CamelX Platform
# SFTP Source
Deploy on CamelX Platform in three steps
Receive data from an SFTP server.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Type | source |
| Group | FTP |
| Namespace | File |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Step 2: Deploy
Click on **"Deploy"**
## Properties
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `connectionHost` | string | ✓ | | The hostname of the SFTP server. |
| `connectionPort` | string | ✓ | `22` | The port of the FTP server. |
| `username` | string | | | The username to access the SFTP server. |
| `password` | string | | | The password to access the SFTP server. |
| `directoryName` | string | ✓ | | The starting directory. |
| `passiveMode` | boolean | | `false` | Sets the passive mode connection. |
| `recursive` | boolean | | `false` | If a directory, look for files in all sub-directories as well. |
| `idempotent` | boolean | | `true` | Skip already-processed files. |
| `ignoreFileNotFoundOrPermissionError` | boolean | | `false` | Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead. |
| `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 starting directory. |
| `delete` | boolean | | `false` | If true, the file will be deleted after it is processed successfully. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:ftp`
- `camel:core`
- `camel:kamelet`