summaryrefslogtreecommitdiffstats
path: root/documentation/webapp/modules.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/webapp/modules.md')
-rw-r--r--documentation/webapp/modules.md30
1 files changed, 30 insertions, 0 deletions
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.