Compare commits

..

4 Commits

Author SHA1 Message Date
c4568a2f23 update doc 2025-12-25 07:56:03 +00:00
0a2937ad55 adding support for dokploy application 2025-12-25 07:39:17 +00:00
ef2b9667fc update doc 2025-12-24 16:50:46 +00:00
1684099f74 update doc 2025-12-24 16:48:43 +00:00
4 changed files with 58 additions and 35 deletions

View File

@@ -2,8 +2,6 @@
A Spring Boot (Java 21) application acting as a secure bridge between Infisical and Dokploy, enabling automated synchronization and deployment of secrets through APIs and webhooks. A Spring Boot (Java 21) application acting as a secure bridge between Infisical and Dokploy, enabling automated synchronization and deployment of secrets through APIs and webhooks.
---
## Features ## Features
- Secure integration with Infisical - Secure integration with Infisical
@@ -11,8 +9,6 @@ A Spring Boot (Java 21) application acting as a secure bridge between Infisical
- Webhook-driven synchronization - Webhook-driven synchronization
- Docker and Docker Compose ready - Docker and Docker Compose ready
---
## Architecture Overview ## Architecture Overview
Infisical Infisical
@@ -21,8 +17,6 @@ InfisicalDokploy Bridge (Spring Boot)
↓ (Dokploy API) ↓ (Dokploy API)
Dokploy Dokploy
---
## Requirements ## Requirements
- Java 21 - Java 21
@@ -30,8 +24,6 @@ Dokploy
- Infisical account - Infisical account
- Dokploy instance with API access - Dokploy instance with API access
---
## Environment Variables ## Environment Variables
### Infisical ### Infisical
@@ -46,8 +38,6 @@ Dokploy
- DOKPLOY_API_URL: Base URL of Dokploy API - DOKPLOY_API_URL: Base URL of Dokploy API
- DOKPLOY_API_KEY: Dokploy API key - DOKPLOY_API_KEY: Dokploy API key
---
## Docker Compose ## Docker Compose
```txt ```txt
@@ -63,7 +53,6 @@ services:
DOKPLOY_API_URL: ${DOKPLOY_API_URL} DOKPLOY_API_URL: ${DOKPLOY_API_URL}
DOKPLOY_API_KEY: ${DOKPLOY_API_KEY} DOKPLOY_API_KEY: ${DOKPLOY_API_KEY}
``` ```
---
## Running ## Running
@@ -83,29 +72,45 @@ Application runs on http://localhost:8080
Use a service like ngrok. Use a service like ngrok.
---
## Infisical Webhook Configuration ## Infisical Webhook Configuration
When creating a webhook in Infisical, the following rules must be respected. When creating a webhook in Infisical, the following rules must be respected.
### Webhook URL format ### Webhook URL Formats
${INFISICAL_API_URL}/webhook?dokployComposeId=${DOKPLOY_COMPOSE_ID} Infisical bridge supports two webhook URL formats, depending on the Dokploy resource you want to update.
- `dokployComposeId` must be the target Dokploy compose identifier #### Dokploy Compose Webhook
- This value is required and used to determine which Dokploy service is updated
`${INFISICAL_API_URL}/webhook?dokployComposeId=${DOKPLOY_COMPOSE_ID}`
Parameters:
- dokployComposeId (required):
The identifier of the target Dokploy Compose.
This value is used to determine which Dokploy compose service should be updated when the webhook is triggered.
#### Dokploy Application Webhook
`${INFISICAL_API_URL}/webhook?dokployApplicationId=${DOKPLOY_APPLICATION_ID}`
Parameters:
- dokployApplicationId (required):
The identifier of the target Dokploy Application.
This value is used to determine which Dokploy application should be updated when the webhook is triggered.
#### Notes
- Exactly one identifier must be provided per webhook URL.
- If no identifier or multiple identifiers are provided, the webhook request will be rejected.
- Ensure the provided ID matches an existing Dokploy resource.
### Webhook Secret ### Webhook Secret
The webhook secret **must exactly match**: The webhook secret **must exactly match**:
${INFISICAL_WEBHOOK_SECRET} `${INFISICAL_WEBHOOK_SECRET}`
Requests with an invalid or missing secret will be rejected. Requests with an invalid or missing secret will be rejected.
---
## Webhooks Behavior ## Webhooks Behavior
- Incoming webhook signatures are validated - Incoming webhook signatures are validated
@@ -113,8 +118,6 @@ Requests with an invalid or missing secret will be rejected.
- Dokploy is updated using its API - Dokploy is updated using its API
- Invalid or unsigned requests are ignored - Invalid or unsigned requests are ignored
---
## Security Notes ## Security Notes
- Secrets are never persisted - Secrets are never persisted
@@ -122,13 +125,11 @@ Requests with an invalid or missing secret will be rejected.
- HTTPS is recommended in production - HTTPS is recommended in production
- Restrict network access to trusted sources only - Restrict network access to trusted sources only
---
## Testing ## Testing
```sh
./gradlew test ./gradlew test
```
---
## Tech Stack ## Tech Stack
@@ -137,8 +138,6 @@ Requests with an invalid or missing secret will be rejected.
- Gradle (Kotlin DSL) - Gradle (Kotlin DSL)
- Docker / Docker Compose - Docker / Docker Compose
---
## License ## License
MIT License MIT License

View File

@@ -4,6 +4,7 @@ import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestBody;
import com.abnov.infisicalbridge.dto.DokployApplicationUpdateRequest;
import com.abnov.infisicalbridge.dto.DokployComposeUpdateRequest; import com.abnov.infisicalbridge.dto.DokployComposeUpdateRequest;
@FeignClient(name = "dokployClient", url = "${dokploy.api-url}", configuration = DokployFeignConfig.class) @FeignClient(name = "dokployClient", url = "${dokploy.api-url}", configuration = DokployFeignConfig.class)
@@ -11,4 +12,7 @@ public interface DokployClient {
@PostMapping("/compose.update") @PostMapping("/compose.update")
void updateCompose(@RequestBody DokployComposeUpdateRequest request); void updateCompose(@RequestBody DokployComposeUpdateRequest request);
@PostMapping("/application.update")
void updateApplication(@RequestBody DokployApplicationUpdateRequest request);
} }

View File

@@ -0,0 +1,6 @@
package com.abnov.infisicalbridge.dto;
public record DokployApplicationUpdateRequest(
String applicationId,
String env) {
}

View File

@@ -13,6 +13,7 @@ import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
import com.abnov.infisicalbridge.dokploy.DokployClient; import com.abnov.infisicalbridge.dokploy.DokployClient;
import com.abnov.infisicalbridge.dto.DokployApplicationUpdateRequest;
import com.abnov.infisicalbridge.dto.DokployComposeUpdateRequest; import com.abnov.infisicalbridge.dto.DokployComposeUpdateRequest;
import com.abnov.infisicalbridge.dto.InfisicalWebhookEventResponse; import com.abnov.infisicalbridge.dto.InfisicalWebhookEventResponse;
import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.core.JsonProcessingException;
@@ -38,7 +39,8 @@ public class InfisicalWebhookController {
@PostMapping @PostMapping
public ResponseEntity<Void> handleWebhook( public ResponseEntity<Void> handleWebhook(
@RequestBody String payload, @RequestBody String payload,
@RequestParam String dokployComposeId, @RequestParam(required = false) String dokployComposeId,
@RequestParam(required = false) String dokployApplicationId,
@RequestHeader(value = "X-Infisical-Signature", required = false) String signature) @RequestHeader(value = "X-Infisical-Signature", required = false) String signature)
throws InfisicalException { throws InfisicalException {
@@ -80,6 +82,7 @@ public class InfisicalWebhookController {
.map(s -> s.getSecretKey() + "=" + s.getSecretValue()) .map(s -> s.getSecretKey() + "=" + s.getSecretValue())
.collect(Collectors.joining("\n")); .collect(Collectors.joining("\n"));
if (dokployComposeId != null) {
try { try {
dokployClient.updateCompose( dokployClient.updateCompose(
new DokployComposeUpdateRequest(dokployComposeId, envContent)); new DokployComposeUpdateRequest(dokployComposeId, envContent));
@@ -87,6 +90,17 @@ public class InfisicalWebhookController {
log.error("Failed to update Dokploy compose {}", dokployComposeId, e); log.error("Failed to update Dokploy compose {}", dokployComposeId, e);
return ResponseEntity.status(HttpStatus.BAD_GATEWAY).build(); return ResponseEntity.status(HttpStatus.BAD_GATEWAY).build();
} }
}
if (dokployApplicationId != null) {
try {
dokployClient.updateApplication(
new DokployApplicationUpdateRequest(dokployApplicationId, envContent));
} catch (Exception e) {
log.error("Failed to update Dokploy application {}", dokployApplicationId, e);
return ResponseEntity.status(HttpStatus.BAD_GATEWAY).build();
}
}
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }