From 638450511ae12b105fc48235c9b1a27b62958299 Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Wed, 26 Jun 2019 14:18:36 +0000 Subject: [documentation] Added ipxe builder module. --- .../.vuepress/public/img/ipxe_builder_console.png | Bin 0 -> 574102 bytes .../public/img/ipxe_builder_console_de.png | Bin 0 -> 568970 bytes .../.vuepress/public/img/ipxe_builder_editor.png | Bin 0 -> 303221 bytes .../public/img/ipxe_builder_editor_de.png | Bin 0 -> 306372 bytes .../public/img/ipxe_builder_parameters.png | Bin 0 -> 423450 bytes .../public/img/ipxe_builder_parameters_de.png | Bin 0 -> 427783 bytes documentation/de/webapp/modules.md | 31 +++++++++++++++++++++ documentation/webapp/modules.md | 30 ++++++++++++++++++++ 8 files changed, 61 insertions(+) create mode 100644 documentation/.vuepress/public/img/ipxe_builder_console.png create mode 100644 documentation/.vuepress/public/img/ipxe_builder_console_de.png create mode 100644 documentation/.vuepress/public/img/ipxe_builder_editor.png create mode 100644 documentation/.vuepress/public/img/ipxe_builder_editor_de.png create mode 100644 documentation/.vuepress/public/img/ipxe_builder_parameters.png create mode 100644 documentation/.vuepress/public/img/ipxe_builder_parameters_de.png (limited to 'documentation') diff --git a/documentation/.vuepress/public/img/ipxe_builder_console.png b/documentation/.vuepress/public/img/ipxe_builder_console.png new file mode 100644 index 0000000..684bb1e Binary files /dev/null and b/documentation/.vuepress/public/img/ipxe_builder_console.png differ diff --git a/documentation/.vuepress/public/img/ipxe_builder_console_de.png b/documentation/.vuepress/public/img/ipxe_builder_console_de.png new file mode 100644 index 0000000..b32b51a Binary files /dev/null and b/documentation/.vuepress/public/img/ipxe_builder_console_de.png differ diff --git a/documentation/.vuepress/public/img/ipxe_builder_editor.png b/documentation/.vuepress/public/img/ipxe_builder_editor.png new file mode 100644 index 0000000..ad261f4 Binary files /dev/null and b/documentation/.vuepress/public/img/ipxe_builder_editor.png differ diff --git a/documentation/.vuepress/public/img/ipxe_builder_editor_de.png b/documentation/.vuepress/public/img/ipxe_builder_editor_de.png new file mode 100644 index 0000000..8790257 Binary files /dev/null and b/documentation/.vuepress/public/img/ipxe_builder_editor_de.png differ diff --git a/documentation/.vuepress/public/img/ipxe_builder_parameters.png b/documentation/.vuepress/public/img/ipxe_builder_parameters.png new file mode 100644 index 0000000..012bf9c Binary files /dev/null and b/documentation/.vuepress/public/img/ipxe_builder_parameters.png differ diff --git a/documentation/.vuepress/public/img/ipxe_builder_parameters_de.png b/documentation/.vuepress/public/img/ipxe_builder_parameters_de.png new file mode 100644 index 0000000..75102da Binary files /dev/null and b/documentation/.vuepress/public/img/ipxe_builder_parameters_de.png differ diff --git a/documentation/de/webapp/modules.md b/documentation/de/webapp/modules.md index 2d8c48e..dabb56e 100644 --- a/documentation/de/webapp/modules.md +++ b/documentation/de/webapp/modules.md @@ -65,6 +65,37 @@ Wenn eine zuvor ausgewählte Gruppe innerhalb einer geblacklisteten Gruppe ist w ## Externe Backends ## Rechtemanager ## iPXE Builder +Diese Module umfasst das ```IPXE```, welches an die Clients, die übers Netzwerk booten, ausgeliefert wird. + +IPXE Builder Parameters + +Der URL zum IPXE-Repository muss bei 1 angegeben werden. + +::: tip +Der standard IPXE-Repository URL ist http://git.ipxe.org/ipxe.git +::: + +Wenn ein anderer als der Master-branch verwendet werden soll, kann der Branchname bei 2 angegeben werden. + +Build Targets können ausgewählt oder hinzugefügt werden 3. +Entweder sind die Build Targets in einer vordefinierten Liste und können dort ausgewählt werden oder es können eigene Build targets hinzugefügt werden, +falls der Administrator in der ```ipxe.config``` Custom Build Targets auf ```true``` gesetzt hat. +Custom Build Targets werden der vordefinierten Liste hinzugefügt können aber durch den Löschen-Button wieder entfernt werden. + +IPXE Builder Console + +Die Konsole zeigt den Output des Bau-Prozesses. +1 säubert das Repository. Das beinhaltet das Löschen vom Log und den geklonten GIT-Dateien. Die Skripte order Konfiguration werden dabei nicht gelöscht.\ +2 ist aktuell ohne Funktion. (bricht den Bau-Prozess ab)\ +3 startet den Bau-Prozess. + +IPXE Builder Editor + +Es gibt mehrere Skripte und Konfiguration, die Editiert werden können. Die verschiedenen Skripte können in der Tabbar 1 ausgewählt werden.\ +Das eingebettete Skript wird beim Bauen in das IPXE mittels des ```EMBED=```-Parameter integriert.\ +Das eingebettete Zertifikat wird mittels des ```TRUST=```-Paramter integriert.\ +Die ```general.h``` und die ```console.h``` sind IPXE Konfigurationen. Sie ersetzten die entsprechenden Dateien in dem geklonten Repository. + ## Nutzermanagement Dieses Modul liefert eine Übersichtstabelle von allen Benutzern. diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md index 716936e..459e972 100644 --- a/documentation/webapp/modules.md +++ b/documentation/webapp/modules.md @@ -64,6 +64,36 @@ If a previously selected group is inside of a blacklisted group, the previously ## Client Registration ## External Backends ## iPXE Builder +This module is all about the ```IPXE``` which gets delivered to the clients when booting over the network. + +IPXE Builder Parameters + +The URL to the ipxe repository has to be defined 1. + +::: tip +The default ipxe repository URL is http://git.ipxe.org/ipxe.git +::: + +Instead of using the master branch, a branchname can be defined with 2. + +Build targets can be selected 3. +Either the build targets in the predefined list can be selected or custom build targets can be added if the administrator enabled custom build targets in the ```ipxe.config``` while setting the value to ```true```. +Custom build targets are added to the predefined list but can be removed using the delete button. + +IPXE Builder Console + +The console shows the output of the building process. +1 cleans the repository. This includes removing the log and the cloned git files. The scripts or configs will stay.\ +2 currently not working. (Should cancel the started building process)\ +3 starts the buildig process. + +IPXE Builder Editor + +There are multiple script/configs which can be edited. The script can be selected within the tabbar 1.\ +The embedded script will be included in the builded ipxe using the ```EMBED=``` parameter.\ +The embedded certificate get included using the ```TRUST=``` parameter.\ +The ```general.h``` and the ```console.h``` are ipxe configurations. They will replace the files in the cloned repository. + ## User Management This module provides a overview table of all the existing users. -- cgit v1.2.3-55-g7522