summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorJannik Schönartz2019-06-26 16:18:36 +0200
committerJannik Schönartz2019-06-26 16:18:36 +0200
commit638450511ae12b105fc48235c9b1a27b62958299 (patch)
treecd2f1fbd3c47b28b5b33996e5e0585d9f5d5556e /documentation
parent[external-backends/idoit] Small bug fix (diff)
downloadbas-638450511ae12b105fc48235c9b1a27b62958299.tar.gz
bas-638450511ae12b105fc48235c9b1a27b62958299.tar.xz
bas-638450511ae12b105fc48235c9b1a27b62958299.zip
[documentation] Added ipxe builder module.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/.vuepress/public/img/ipxe_builder_console.pngbin0 -> 574102 bytes
-rw-r--r--documentation/.vuepress/public/img/ipxe_builder_console_de.pngbin0 -> 568970 bytes
-rw-r--r--documentation/.vuepress/public/img/ipxe_builder_editor.pngbin0 -> 303221 bytes
-rw-r--r--documentation/.vuepress/public/img/ipxe_builder_editor_de.pngbin0 -> 306372 bytes
-rw-r--r--documentation/.vuepress/public/img/ipxe_builder_parameters.pngbin0 -> 423450 bytes
-rw-r--r--documentation/.vuepress/public/img/ipxe_builder_parameters_de.pngbin0 -> 427783 bytes
-rw-r--r--documentation/de/webapp/modules.md31
-rw-r--r--documentation/webapp/modules.md30
8 files changed, 61 insertions, 0 deletions
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
--- /dev/null
+++ b/documentation/.vuepress/public/img/ipxe_builder_console.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/ipxe_builder_console_de.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/ipxe_builder_editor.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/ipxe_builder_editor_de.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/ipxe_builder_parameters.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/ipxe_builder_parameters_de.png
Binary files 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.
+
+<a :href="$withBase('/img/ipxe_builder_parameters_de.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_parameters_de.png')" alt="IPXE Builder Parameters"></a>
+
+Der URL zum IPXE-Repository muss bei <span class="tutorial-label">1</span> angegeben werden.
+
+::: tip
+Der standard IPXE-Repository URL ist <a>http://git.ipxe.org/ipxe.git</a>
+:::
+
+Wenn ein anderer als der Master-branch verwendet werden soll, kann der Branchname bei <span class="tutorial-label">2</span> angegeben werden.
+
+Build Targets können ausgewählt oder hinzugefügt werden <span class="tutorial-label">3</span>.
+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.
+
+<a :href="$withBase('/img/ipxe_builder_console_de.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_console_de.png')" alt="IPXE Builder Console"></a>
+
+Die Konsole zeigt den Output des Bau-Prozesses.
+<span class="tutorial-label">1</span> 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.\
+<span class="tutorial-label">2</span> ist aktuell ohne Funktion. (bricht den Bau-Prozess ab)\
+<span class="tutorial-label">3</span> startet den Bau-Prozess.
+
+<a :href="$withBase('/img/ipxe_builder_editor_de.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_editor_de.png')" alt="IPXE Builder Editor"></a>
+
+Es gibt mehrere Skripte und Konfiguration, die Editiert werden können. Die verschiedenen Skripte können in der Tabbar <span class="tutorial-label">1</span> 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.
+
+<a :href="$withBase('/img/ipxe_builder_parameters.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_parameters.png')" alt="IPXE Builder Parameters"></a>
+
+The URL to the ipxe repository has to be defined <span class="tutorial-label">1</span>.
+
+::: tip
+The default ipxe repository URL is <a>http://git.ipxe.org/ipxe.git</a>
+:::
+
+Instead of using the master branch, a branchname can be defined with <span class="tutorial-label">2</span>.
+
+Build targets can be selected <span class="tutorial-label">3</span>.
+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.
+
+<a :href="$withBase('/img/ipxe_builder_console.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_console.png')" alt="IPXE Builder Console"></a>
+
+The console shows the output of the building process.
+<span class="tutorial-label">1</span> cleans the repository. This includes removing the log and the cloned git files. The scripts or configs will stay.\
+<span class="tutorial-label">2</span> currently not working. (Should cancel the started building process)\
+<span class="tutorial-label">3</span> starts the buildig process.
+
+<a :href="$withBase('/img/ipxe_builder_editor.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_editor.png')" alt="IPXE Builder Editor"></a>
+
+There are multiple script/configs which can be edited. The script can be selected within the tabbar <span class="tutorial-label">1</span>.\
+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.