mirror/dirigent-spring
1
0
Fork 0
mirror of https://github.com/DerDavidBohl/dirigent-spring.git synced 2026-01-06 00:40:07 -06:00
Code Issues Packages Projects Releases 13 Wiki Activity

Added Documentation

Browse Source
This commit is contained in:
DerDavidBohl
2025-01-10 06:59:07 +01:00
parent 99eaa4bfa3
commit 78235674a3
2 changed files with 34 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Dockerfile
View File

@@ -7,6 +7,8 @@ RUN mvn clean package -DskipTests
# Use OpenJDK image to run the application
FROM openjdk:23-jdk-slim-bullseye
# Install Docker
RUN apt-get update
RUN apt-get install -y ca-certificates curl
RUN install -m 0755 -d /etc/apt/keyrings
@@ -16,8 +18,7 @@ RUN echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/doc
RUN apt-get update
RUN apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
# Finish
WORKDIR /app
COPY --from=build /app/target/*.jar app.jar
EXPOSE 8080

32
README.md
View File

@@ -1,5 +1,7 @@
# Dirigent
Tool to manage your docker compose deployments via git.
## Setup
### docker-compose
@@ -12,7 +14,7 @@ services:
restart: unless-stopped
environment:
- DIRIGENT_DEPLOYMENTS_GIT_URL=<Your Deployments Repo>
- DIRIGENT_GIT_AUTHTOKEN=<Your Auth token with Access to your repos (only if needed)>
- DIRIGENT_GIT_AUTHTOKEN=<Your Auth token with Access to your repos - only if needed>
ports:
- 8080:8080
volumes:
@@ -21,3 +23,31 @@ services:
- /var/run/docker.sock:/var/run/docker.sock
```
### docker CLI
```bash
docker run -d \
--name=dirigent \
-e DIRIGENT_DEPLOYMENTS_GIT_URL=<Your Deployments Repo> \
-e DIRIGENT_GIT_AUTHTOKEN=<Your Auth token with Access to your repos - only if needed> \
-v /path/to/config:/app/config \
-v /path/to/deployments:/app/deployments \
-v /var/run/docker.sock:/var/run/docker.sock \
ghcr.io/derdavidbohl/dirigent-spring:latest
```
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| DIRIGENT_DEPLOYMENTS_GIT_URL | URL to your deployments git repository | |
| DIRIGENT_GIT_AUTHTOKEN | Auth token with access to your repos | |
### Volumes
| Volume | Description |
|--------|-------------|
| /app/config | Config directory for Dirigent |
| /app/deployments | Deployments directory for Dirigent |
| /var/run/docker.sock | Docker socket for Dirigent |