Document the cli arguments in README
This commit is contained in:
parent
2290958cce
commit
9098246cce
1 changed files with 16 additions and 0 deletions
16
README.md
16
README.md
|
@ -14,7 +14,9 @@ This bastion project does work properly with non interactive sessions, which all
|
|||
- [Manual installation](#manual-installation)
|
||||
- [Configuration](#configuration)
|
||||
- [Usage](#usage)
|
||||
- [Session recording](#session-recording)
|
||||
- [Docker](#docker)
|
||||
- [Log management](#log-management)
|
||||
- [Monitoring](#monitoring)
|
||||
- [Backup](#backup)
|
||||
- [Scaling](#scaling)
|
||||
|
@ -73,8 +75,22 @@ session_recording:
|
|||
|
||||
## Usage
|
||||
|
||||
```
|
||||
julien@hurricane ~/git/bastion/build (master *$%) $ bastion -h
|
||||
Usage: bastion [-h] [-v] [-t] [-f] [-c STRING]
|
||||
-h : show this help message and exit
|
||||
-v : show version and exit
|
||||
-t : test configuration file and exit
|
||||
-f : stay in foreground (don't fork)
|
||||
-c : specify a path to a configuration file to use instead of the default /home/julien/.local/etc/bastion/bastion.conf
|
||||
```
|
||||
|
||||
## Session recording
|
||||
|
||||
## Docker
|
||||
|
||||
## Log management
|
||||
|
||||
## Monitoring
|
||||
|
||||
## Backup
|
||||
|
|
Reference in a new issue