Update wiki Home page for cm-sms

gitea_admin 2026-03-11 14:36:39 +00:00
parent 3959c4a1c6
commit 45f9b8d954

40
Home.md

@ -1,21 +1,33 @@
# Deploy the Project on CamelX Platform # CM SMS Gateway
Deploy on CamelX Platform in three steps Send SMS messages via CM SMS Gateway.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `cm-sms` |
| Support Level | Stable |
| Labels | mobile |
| Version | 4.10.2 |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-cm-sms</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `host` | string | ✓ | | SMS Provider HOST with scheme |
| `defaultFrom` | string | ✓ | | This is the sender name. The maximum length is 11 characters. |
| `defaultMaxNumberOfParts` | integer | | `8` | If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters. |
| `productToken` | string | ✓ | | The unique token to use |
| `testConnectionOnStartup` | boolean | | `false` | Whether to test the connection to the SMS Gateway on startup |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |