Update wiki Home page for geocoder

gitea_admin 2026-03-11 14:38:05 +00:00
parent b020cab951
commit 579706d2d0

51
Home.md

@ -1,21 +1,44 @@
# Deploy the Project on CamelX Platform
# Geocoder
Deploy on CamelX Platform in three steps
Find geocodes (latitude and longitude) for a given address or the other way round.
## 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 |
|----------|-------|
| Scheme | `geocoder` |
| Support Level | Stable |
| Labels | api,search |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-geocoder</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `address` | string | | | The geo address which should be prefixed with address: |
| `latlng` | string | | | The geo latitude and longitude which should be prefixed with latlng: |
| `headersOnly` | boolean | | `false` | Whether to only enrich the Exchange with headers, and leave the body as-is. |
| `language` | string | | `en` | The language to use. |
| `serverUrl` | string | | | URL to the geocoder server. Mandatory for Nominatim server. |
| `type` | object | | | Type of GeoCoding server. Supported Nominatim and Google. |
| `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. |
| `proxyAuthDomain` | string | | | Proxy Authentication Domain to access Google GeoCoding server. |
| `proxyAuthHost` | string | | | Proxy Authentication Host to access Google GeoCoding server. |
| `proxyAuthMethod` | string | | | Authentication Method to Google GeoCoding server. |
| `proxyAuthPassword` | string | | | Proxy Password to access GeoCoding server. |
| `proxyAuthUsername` | string | | | Proxy Username to access GeoCoding server. |
| `proxyHost` | string | | | Proxy Host to access GeoCoding server. |
| `proxyPort` | integer | | | Proxy Port to access GeoCoding server. |
| `apiKey` | string | | | API Key to access Google. Mandatory for Google GeoCoding server. |
| `clientId` | string | | | Client ID to access Google GeoCoding server. |
| `clientKey` | string | | | Client Key to access Google GeoCoding server. |