Skip to content

Commit

Permalink
Add doc regarding the docker volume and update docker compose file (#14)
Browse files Browse the repository at this point in the history
* chore: remove deprecated `version` config.

* chore: add volume info. Fixes #2
  • Loading branch information
gcavalcante8808 authored Jul 3, 2024
1 parent d6425e4 commit 4efeca7
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
25 changes: 24 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down Expand Up @@ -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.
2 changes: 0 additions & 2 deletions docker-compose.tests.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: '2.2'

services:
kdc:
environment:
Expand Down
1 change: 0 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
version: '2.2'
volumes:
krb5kdc-data:

Expand Down

0 comments on commit 4efeca7

Please sign in to comment.