chore: update the doc and config file

canonical · Jan 25, 2024 · 42bdbce · 42bdbce
1 parent e5a56c1
commit 42bdbce
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,12 +21,21 @@ installed. Import the created ROCK image into Docker:
 $ sudo /snap/rockcraft/current/bin/skopeo --insecure-policy copy oci-archive:<local-rock-name>.rock docker-daemon:<image-name>:<image-tag>
 ```
 
-Run a GLAuth container using Docker:
+Run a GLAuth container using Docker with [a minimum working config file](config/glauth.cfg):
 
 ```shell
-$ docker run --rm -p 127.0.0.1:3893:3893/tcp --name <container-name> <image-name>:<image-tag>
+$ docker run -d \
+    --rm \
+    -p 127.0.0.1:3893:3893/tcp \
+    --name <container-name> \
+    <image-name>:<image-tag>
 ```
 
+> ⚠️ **NOTE**
+>
+> Please refer to the [GLAuth](https://github.com/glauth/glauth) for more
+> details about the configuration file.
+
 ## Deploying
 
 ### Prerequisites

diff --git a/config/glauth.cfg b/config/glauth.cfg
@@ -4,6 +4,9 @@ structuredlog = true
 [ldap]
   enabled = true
   listen = "0.0.0.0:3893"
+  tls = false
+  tlsCertPath = "glauth.crt"
+  tlsKeyPath = "glauth.key"
 
 [ldaps]
   enabled = false