Fixes #65

.github/dependabot.yml

@@ -3,4 +3,9 @@ updates:
   - package-ecosystem: "maven"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/push-snapshots.yaml

@@ -53,3 +53,11 @@ jobs:
 
       - name: Docker Build and Push the snapshot image
         run: docker buildx build --push -f Dockerfile --tag kwart/ldap-server:latest .
+
+      - name: Update Docker description
+        uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: kwart/ldap-server
+          readme-filepath: ./README-docker.md

README-docker.md

@@ -0,0 +1,25 @@
+# Docker ldap-server image
+
+Distroless Java Docker image with Apache DS based LDAP server
+
+Use the `latest` tag to have up-to-date version.
+
+## How to run it
+
+### Default LDIF
+
+```bash
+docker run -it --rm -p 10389:10389 -p 10636:10636 kwart/ldap-server 
+```
+
+### Custom LDIF
+
+If the LDIF is located in the current directory and named `custom.ldif`
+
+```bash
+docker run -it --rm \
+    -p 10389:10389 \
+    -v `pwd`:/mnt \
+    kwart/ldap-server \
+    /mnt/custom.ldif
+```