update doc #6

Merged
aboutrax merged 1 commits from dev into main 2025-12-24 16:49:21 +00:00

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.
---
## Features
- Secure integration with Infisical
@@ -11,8 +9,6 @@ A Spring Boot (Java 21) application acting as a secure bridge between Infisical
- Webhook-driven synchronization
- Docker and Docker Compose ready
---
## Architecture Overview
Infisical
@@ -21,8 +17,6 @@ InfisicalDokploy Bridge (Spring Boot)
↓ (Dokploy API)
Dokploy
---
## Requirements
- Java 21
@@ -30,8 +24,6 @@ Dokploy
- Infisical account
- Dokploy instance with API access
---
## Environment Variables
### Infisical
@@ -46,8 +38,6 @@ Dokploy
- DOKPLOY_API_URL: Base URL of Dokploy API
- DOKPLOY_API_KEY: Dokploy API key
---
## Docker Compose
```txt
@@ -63,7 +53,6 @@ services:
DOKPLOY_API_URL: ${DOKPLOY_API_URL}
DOKPLOY_API_KEY: ${DOKPLOY_API_KEY}
```
---
## Running
@@ -91,7 +80,7 @@ When creating a webhook in Infisical, the following rules must be respected.
### Webhook URL format
${INFISICAL_API_URL}/webhook?dokployComposeId=${DOKPLOY_COMPOSE_ID}
`${INFISICAL_API_URL}/webhook?dokployComposeId=${DOKPLOY_COMPOSE_ID}`
- `dokployComposeId` must be the target Dokploy compose identifier
- This value is required and used to determine which Dokploy service is updated
@@ -100,7 +89,7 @@ ${INFISICAL_API_URL}/webhook?dokployComposeId=${DOKPLOY_COMPOSE_ID}
The webhook secret **must exactly match**:
${INFISICAL_WEBHOOK_SECRET}
`${INFISICAL_WEBHOOK_SECRET}`
Requests with an invalid or missing secret will be rejected.
@@ -126,7 +115,9 @@ Requests with an invalid or missing secret will be rejected.
## Testing
```sh
./gradlew test
```
---