diff --git a/README.md b/README.md index b8d4d30..9cce840 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ Bifröst (spoken as "Bee-frest"), is an advanced SSH server. It can be used as a ## TOC +* [Use-cases](doc/usecases.md) * [Features](#features) * [Getting started](#getting-started) +* [Configuration](doc/configuration.md) * [Status](#status) * [License](LICENSE) * [Code of Conduct](CODE_OF_CONDUCT.md) @@ -45,11 +47,11 @@ It can also automatically clean up these users as they're no longer needed, for ```shell # Syntax curl -sSLf https://github.com/engity-com/bifroest/releases/download//bifroest---.tgz | sudo tar -zxv -C /usr/bin bifroest - + # Example curl -sSLf https://github.com/engity-com/bifroest/releases/download/v1.2.3/bifroest-linux-amd64-extended.tgz | sudo tar -zxv -C /usr/bin bifroest ``` -2. Configure Bifröst. For example download the demo configuration and adjust for your needs (see [our demo configuration](doc/configurations/demo.yaml) for the documentation about it): +2. Configure Bifröst. For example download the demo configuration and adjust for your needs (see [documentation of configuration](doc/configuration.md) for the documentation about it): ```shell sudo mkdir -p /etc/engity/bifroest/ sudo curl -sSLf https://raw.githubusercontent.com/engity-com/bifroest/main/doc/configurations/sshd-dropin-replacement.yaml -o /etc/engity/bifroest/configuration.yaml @@ -80,11 +82,17 @@ To enable Bifröst to run at every server start where [systemd](https://wiki.arc sudo systemctl start bifroest.service ``` +### What's next? + +Read [Use-Cases](doc/usecases.md) and [the configuration documentation](doc/configuration.md) to see what you can do more with Bifröst. + ## Status This project is currently under development. The application is stable ([file a bug if you find one](https://github.com/engity-com/bifroest/issues/new/choose)), but the configuration/command/API structure needs improvement. ## More topics +* [Use-Cases](doc/usecases.md) +* [Configuration](doc/configuration.md) * [License](LICENSE) * [Code of Conduct](CODE_OF_CONDUCT.md) * [Contributing](CONTRIBUTING.md) diff --git a/doc/configuration.md b/doc/configuration.md new file mode 100644 index 0000000..07cc086 --- /dev/null +++ b/doc/configuration.md @@ -0,0 +1,3 @@ +# Engity's Bifröst Configuration + +Currently, please see [our demo configuration](configurations/demo.yaml) for details how to configure Bifröst. diff --git a/doc/configurations/README.md b/doc/configurations/README.md deleted file mode 100644 index 96432b0..0000000 --- a/doc/configurations/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Engity's Bifröst Configuration - -Currently, please see [our demo configuration](demo.yaml) for details how to configure Bifröst. diff --git a/doc/usecases.md b/doc/usecases.md index 96eac25..2f6008c 100644 --- a/doc/usecases.md +++ b/doc/usecases.md @@ -1,6 +1,6 @@ # Engity's Bifröst Use-cases -As Bifröst is very flexible how it can be configured (see [configuration documentation](configurations/README.md)), here some use-cases which can be fulfilled by it: +As Bifröst is very flexible how it can be configured (see [configuration documentation](configuration)), here some use-cases which can be fulfilled by it: 1. [**Off**-board users within 15 minutes of the organization](#offboard) 2. [**On**-board users within 15 minutes in the organization](#onboard)