From 7c871e38b200b417651efda7fd363bf9b8d694a3 Mon Sep 17 00:00:00 2001 From: Gregor Noczinski Date: Tue, 27 Aug 2024 17:52:08 +0200 Subject: [PATCH] Changes --- README.md | 2 ++ doc/flows.md | 17 ++++++++++++++++- doc/usecases.md | 4 ++++ 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cce840..b439c7c 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Bifröst (spoken as "Bee-frest"), is an advanced SSH server. It can be used as a * [License](LICENSE) * [Code of Conduct](CODE_OF_CONDUCT.md) * [Contributing](CONTRIBUTING.md) +* [Security](SECURITY.md) ## Features @@ -96,3 +97,4 @@ This project is currently under development. The application is stable ([file a * [License](LICENSE) * [Code of Conduct](CODE_OF_CONDUCT.md) * [Contributing](CONTRIBUTING.md) +* [Security](SECURITY.md) diff --git a/doc/flows.md b/doc/flows.md index f32e996..48b1904 100644 --- a/doc/flows.md +++ b/doc/flows.md @@ -1,3 +1,18 @@ # Engity's Bifröst Flows -⚠️ Work in progress. +A flow represents a flow of a user's session from the [authorization](authorizations.md) to the active [environment](environments.md). + +```mermaid +flowchart TD + Requirement("If the Requirement is fulfilled?") + Authorization("Is the user is successfully authorized?") + Environment("Execute the user into the environment.") + + Requirement --> Authorization --> Environment +``` +## Requirement + +## Authorization + +## Environment + diff --git a/doc/usecases.md b/doc/usecases.md index 2f6008c..dea3893 100644 --- a/doc/usecases.md +++ b/doc/usecases.md @@ -117,3 +117,7 @@ You're using Bifröst with multiple [flows](flows.md), configured. Each flow can You simply want to use something else than [OpenSSH sshd](https://man.openbsd.org/sshd.8), Bifröst will do this, too. 😉 Just use [this configuration](configurations/sshd-dropin-replacement.yaml). + +## More topics +* [Configuration](configuration.md) +* [Features](../README.md#features)