From 1b9a3e8c4bdb99f7713958a3f284e06438b95bb1 Mon Sep 17 00:00:00 2001
From: Julien Dessaux
Date: Thu, 14 Mar 2019 23:34:55 +0100
Subject: Made all settings customisable through a config file.

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3b817cd..d2cf716 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,8 @@ This bastion project does work properly with non interactive sessions, which all
 ## Contents
 
 - [Dependencies](#dependencies)
-- [Installation and usage](#manual-installation)
+- [Manual installation](#manual-installation)
+- [Configuration](#configuration)
 - [Usage](#usage)
 - [Docker](#docker)
 - [Monitoring](#monitoring)
@@ -20,7 +21,8 @@ This bastion project does work properly with non interactive sessions, which all
 
 ## Dependencies
 
-This project has only one hard dependency :
+This project has only two hard dependencies :
+- the libconfig from http://www.hyperrealm.com/libconfig/libconfig.html
 - the libssh from https://www.libssh.org/. You should be able to use your distro's packages if they are recent enough.
 
 The following are optional dependencies :
@@ -49,6 +51,25 @@ For exemple this disables session recording for a debug build and installs the b
 
 `cmake .. -DCMAKE_BUILD_TYPE=Debug -D CMAKE_INSTALL_PREFIX=$HOME/.local -DSESSION_RECORDING=OFF`
 
+## Configuration
+
+Here is the default configuration :
+```
+port = 2222;
+
+keys:
+{
+    dsa = "/home/julien/.local/etc/bastion/ssh_host_dsa_key";
+    rsa = "/home/julien/.local/etc/bastion/ssh_host_rsa_key";
+    ecdsa = "/home/julien/.local/etc/bastion/ssh_host_ecdsa_key";
+};
+
+session_recording:
+{
+    path = "/home/julien/.local/var/log/bastion/$d/$h/$u/$i.gz";     # $d : date in iso format, $h : hostname, $u : username : $i session id
+};
+```
+
 ## Usage
 
 ## Docker
-- 
cgit v1.2.3