summaryrefslogtreecommitdiffstats
path: root/doc/20-Editor.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/20-Editor.md')
-rw-r--r--doc/20-Editor.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/20-Editor.md b/doc/20-Editor.md
new file mode 100644
index 0000000..28dd5c2
--- /dev/null
+++ b/doc/20-Editor.md
@@ -0,0 +1,26 @@
+Config Editor
+=============
+
+The module ships a very basic configuration editor,
+which allows to to edit the bare YAML configuration within the web interface.
+
+Please also see the [chapter on config format](21-Config-Format.md).
+
+## Saving
+
+You have 2 options on saving:
+
+* Save to session - so you can test and review your edit
+* Save to disk - it is stored to disk and visible for everyone
+
+When you have saved changes to your session, but not yet disk, the interface
+reminds you of that.
+
+Also you can cancel an edit with a button below the editor, and return to disk state.
+
+## History
+
+Config history is saved to disk, so it can be restored manually.
+But there is not interface yet.
+
+See `/etc/icingaweb2/modules/toplevelview/views/<name>/*.yml`.