From 4efeca7db55f0702ddcb10ea6537d557aec3fe76 Mon Sep 17 00:00:00 2001 From: Gabriel Abdalla Cavalcante Date: Wed, 3 Jul 2024 15:13:00 -0300 Subject: [PATCH] Add doc regarding the docker volume and update docker compose file (#14) * chore: remove deprecated `version` config. * chore: add volume info. Fixes #2 --- README.MD | 25 ++++++++++++++++++++++++- docker-compose.tests.yml | 2 -- docker-compose.yml | 1 - 3 files changed, 24 insertions(+), 4 deletions(-) diff --git a/README.MD b/README.MD index e8e50b4..f8d5c1a 100644 --- a/README.MD +++ b/README.MD @@ -15,6 +15,29 @@ If you just want to create a Krb5 Server from scratch, just clone the repository docker-compose up -d ``` +By default, an anonymous volume will be created and mounted on /var/lib/krb5kdc but you can mount your own +volume. Use the example bellow as a guide: + +```yml +volumes: + krb5kdc-data: + +services: + kdc: + image: gcavalcante8808/krb5-server + build: . + restart: always + ports: + - "88:88" + - "464:464" + - "749:749" + environment: + KRB5_REALM: EXAMPLE.COM + KRB5_KDC: localhost + volumes: + - krb5kdc-data:/var/lib/krb5kdc +``` + Usage ----- @@ -123,6 +146,6 @@ Running Tests There are a set of tests (written in python) available on the tests directory. -You can the tests by running `make run-tests-on-docker` command. +You run can the tests by running `make run-tests-on-docker` command. Note: By Default, it requires docker/docker-compose and make installed and working. diff --git a/docker-compose.tests.yml b/docker-compose.tests.yml index 50f47d1..f679369 100644 --- a/docker-compose.tests.yml +++ b/docker-compose.tests.yml @@ -1,5 +1,3 @@ -version: '2.2' - services: kdc: environment: diff --git a/docker-compose.yml b/docker-compose.yml index 11ff2fa..b4566c8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,4 +1,3 @@ -version: '2.2' volumes: krb5kdc-data: