From ed8ecab38ccbc4f028fba4e6a3301b52f5a019ae Mon Sep 17 00:00:00 2001 From: Florian RICHER Date: Thu, 2 Feb 2023 21:16:51 +0100 Subject: [PATCH] Add default book --- book/.gitignore | 1 + book/book.toml | 6 ++++++ book/src/SUMMARY.md | 3 +++ book/src/introduction.md | 30 ++++++++++++++++++++++++++++++ 4 files changed, 40 insertions(+) create mode 100644 book/.gitignore create mode 100644 book/book.toml create mode 100644 book/src/SUMMARY.md create mode 100644 book/src/introduction.md diff --git a/book/.gitignore b/book/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/book/.gitignore @@ -0,0 +1 @@ +book diff --git a/book/book.toml b/book/book.toml new file mode 100644 index 0000000..12abe04 --- /dev/null +++ b/book/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Florian RICHER"] +language = "en" +multilingual = false +src = "src" +title = "Command gateway" diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md new file mode 100644 index 0000000..e0ff9f9 --- /dev/null +++ b/book/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Introduction](./introduction.md) diff --git a/book/src/introduction.md b/book/src/introduction.md new file mode 100644 index 0000000..3494f07 --- /dev/null +++ b/book/src/introduction.md @@ -0,0 +1,30 @@ +# Introduction + +Hello, and welcome to the [PROJECT_NAME] project. +The goal of this project is to offer simple gateway to run script as command added by the DevOps. +The project is composed of two principal elements. + +### 1. Command interpreter + +Interpreter is the user main interface can be accessed like BASH. +It can be configured as default login user like that: + +```shell +useradd -s /path/to/interpreter [USER] +``` + +or + +```shell +chsh [USER] /path/to/interpreter +``` + +### 2. Daemon + +- It's used to manage interpreter session (Kill session, list, authenticate, ....). +- Allow external program to communicate with UNIX socket like external API or CLI. +- Allow use HTTP or UNIX Socket external authenticator. +It can be useful for integrate Oauth, OpenID, LDAP, ... from any language support GRPC protocol from protobuf. + + +