Add default book
This commit is contained in:
parent
770a55fb2c
commit
ed8ecab38c
4 changed files with 40 additions and 0 deletions
1
book/.gitignore
vendored
Normal file
1
book/.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
book
|
6
book/book.toml
Normal file
6
book/book.toml
Normal file
|
@ -0,0 +1,6 @@
|
|||
[book]
|
||||
authors = ["Florian RICHER"]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "Command gateway"
|
3
book/src/SUMMARY.md
Normal file
3
book/src/SUMMARY.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Summary
|
||||
|
||||
- [Introduction](./introduction.md)
|
30
book/src/introduction.md
Normal file
30
book/src/introduction.md
Normal file
|
@ -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.
|
||||
|
||||
|
||||
|
Reference in a new issue