Update wiki Home page for scp-sink

gitea_admin 2026-03-11 14:40:01 +00:00
parent e6918eb005
commit f884f92d4d

39
Home.md

@ -1,21 +1,32 @@
# Deploy the Project on CamelX Platform
# SCP Sink
Deploy on CamelX Platform in three steps
Send file to an FTP Server through Secure Copy Protocol
## 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 | sink |
| Group | SCP |
| 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 |
|------|------|----------|---------|-------------|
| `serverName` | string | ✓ | | The hostname of the FTP server |
| `serverPort` | string | ✓ | | The port of the FTP server |
| `username` | string | | | Username for accessing FTP Server |
| `password` | string | | | Password for accessing FTP Server |
| `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. |
| `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. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:jsch`
- `camel:kamelet`