summaryrefslogtreecommitdiffstats
path: root/documentation/webapp
diff options
context:
space:
mode:
authorJannik Schönartz2020-04-15 20:02:26 +0200
committerJannik Schönartz2020-04-15 20:02:26 +0200
commitdc68a5f080f939b57834360504174385dd8be0b9 (patch)
treea870edba1bc048b3cb1714f88d12b483aac2bb1b /documentation/webapp
parent[permissionmanager] split permissions in one file per module (diff)
downloadbas-dc68a5f080f939b57834360504174385dd8be0b9.tar.gz
bas-dc68a5f080f939b57834360504174385dd8be0b9.tar.xz
bas-dc68a5f080f939b57834360504174385dd8be0b9.zip
[documentation] Add documentation for external backends.
Diffstat (limited to 'documentation/webapp')
-rw-r--r--documentation/webapp/README.md2
-rw-r--r--documentation/webapp/modules.md40
2 files changed, 40 insertions, 2 deletions
diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md
index 40a737a..3407467 100644
--- a/documentation/webapp/README.md
+++ b/documentation/webapp/README.md
@@ -11,7 +11,7 @@ The sidepanel can be opened and closed with <span class="tutorial-label">2</span
There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings).
> <span class="tutorial-label">3</span> changes the style of the webapplication between a light and a dark theme.\
> <span class="tutorial-label">4</span> opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.\
-> <span class="tutorial-label">5</span> opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or log out of the webapplication.
+> <span class="tutorial-label">5</span> opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account), the [Settings](/webapp/README.md#settings) or log out of the webapplication.
## User Account
In the user account module the user is able to change some of his information.
diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md
index 9a20aa2..c1d7918 100644
--- a/documentation/webapp/modules.md
+++ b/documentation/webapp/modules.md
@@ -108,8 +108,46 @@ The list is used for selecting groups and clients which shall be excluded from t
If a previously selected group is inside of a blacklisted group, the previously selected group is not excluded from the event.
:::
+
## Client Registration
+
## External Backends
+This module connects external backends with the ```BAS``` to import or sync data from external sources like ```iDoIT``` or ```infoblox```.
+
+<a :href="$withBase('/img/external_backends.png')" target="_blank"><img :src="$withBase('/img/external_backends.png')" alt="External Backends"></a>
+
+A connection to the backend can be created <span class="tutorial-label">1</span> or removed <span class="tutorial-label">2</span>.
+When adding a new backend connection a dialog window will open where the connection can be established.
+See [Add External Backend](/webapp/modules.html#add-edit-external-backend) for more information on the setup process.
+
+To verify wheather the connection of a single backend is successfull established <span class="tutorial-label">4</span> can be pressed.
+To verfiy multiple backends at once, they can be selected and verified with <span class="tutorial-label">3</span>.
+If the connection is successfull established, the icon will change it's color to <span class="text-success">green</span>. If the connection check fails the icon color will be <span class="text-error">red</span>.
+<span class="tutorial-label">5</span> opens the [sync-settings](/webapp/modules.html#sync-settings) and
+<span class="tutorial-label">6</span> opens up the [edit-window](/webapp/modules.html#add-external-backend).
+
+### Add/Edit External Backend
+When adding a new external backend, the first step is the selection of the backend type.
+<a :href="$withBase('/img/external_backends_add_1.png')" target="_blank"><img :src="$withBase('/img/external_backends_add_1.png')" alt="External Backends Add Step 1"></a>
+In the second step all the credentials the backend requires can be filled in.
+
+::: danger
+The credentials of the backend will be saved as plaintext in the database, because some backends need the password as plaintext to authenticate.
+So be careful, what you insert here. Everyone with access to the database can read the credentials.
+:::
+
+<a :href="$withBase('/img/external_backends_add_2.png')" target="_blank"><img :src="$withBase('/img/external_backends_add_2.png')" alt="External Backends Add Step 2"></a>
+Because every backend has different requirements, this windows can look different. The example in the picture above is for an ```iDoIT```-Backend.
+
+### Sync Settings
+In the sync settings objecttypes from the external backend can be specified to be either a ```group``` or a ```client```.
+A ```group``` is like a location, it can have other groups as subgroups and clients as children. For example a building can have multiple rooms and a room can have clients inside.
+A ```client``` on the other side doesn't have any children at all. A client is for example a pc or a server. See [Groups / Clients](/webapp/modules.html#groups-clients) for more information.
+::: warning
+Sync types are currently not implemented.
+:::
+<a :href="$withBase('/img/external_backends_sync.png')" target="_blank"><img :src="$withBase('/img/external_backends_sync.png')" alt="External Backends Sync"></a>
+
## iPXE Builder
This module is all about the ```iPXE``` which gets delivered to the clients when booting over the network.
@@ -157,4 +195,4 @@ Permissions:
* Edit - The permission to edit users.
* Delete - The permission to delete users.
-## Permission Manager \ No newline at end of file
+## Permission Manager