abnov/infisical-bridge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Aboubacar TRAORE
2025-12-24 16:48:43 +00:00
parent a65b2dbeb0
commit 1684099f74
1 changed files with 4 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
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 @@ Infisical–Dokploy 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
@@ -91,7 +80,7 @@ When creating a webhook in Infisical, the following rules must be respected.
### Webhook URL format ### 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 - `dokployComposeId` must be the target Dokploy compose identifier
- This value is required and used to determine which Dokploy service is updated - 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**: 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.
@@ -126,7 +115,9 @@ Requests with an invalid or missing secret will be rejected.
## Testing ## Testing
```sh
./gradlew test ./gradlew test
```
--- ---