Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/cli_parameters/config/disk_encryption.rst
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2023-11-21 14:34:30 +0100
committerGitHub <noreply@github.com>2023-11-21 14:34:30 +0100
commitcc806d9c4ce29212c2848c15b4b184feace3e1ac (patch)
tree28f4f1cb3b943d178a07a37369d3133093c51e17 /docs/cli_parameters/config/disk_encryption.rst
parente6344f93f7e476d05bbcd642f2ed91fdde545870 (diff)
Started a re-write of the docs (#1967)
* Started a re-write of the docs, using CSV for tables and re-organizing parameter definitions * Added final config options in --config, some have external references which needs to be populated * Forgot to escape a comma * Clarified a note * Added disk configuration and disk encryption docs * Changed way of installing using source and python * Added a 'list script' that lists available scripts. This could be converted to a argparse later. But this does the trick for now. And it's added to ease documentation and listing of available options. * Added a 'Known issues' section, as well as renamed the issues tab * Finished up the known issues section * Added a section regarding --plugin * Added plugin description, tweaked disk_config to the latest changes from #2221 * Added custom-commands docs, and improved some creds and known issue links
Diffstat (limited to 'docs/cli_parameters/config/disk_encryption.rst')
-rw-r--r--docs/cli_parameters/config/disk_encryption.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/cli_parameters/config/disk_encryption.rst b/docs/cli_parameters/config/disk_encryption.rst
new file mode 100644
index 00000000..df2e2fa7
--- /dev/null
+++ b/docs/cli_parameters/config/disk_encryption.rst
@@ -0,0 +1,19 @@
+.. _disk encryption:
+
+Disk Encryption
+===============
+
+Disk encryption consists of a top level entry in the user configuration.
+
+.. code-block:: json
+
+ {
+ "disk_encryption": {
+ "encryption_type": "luks",
+ "partitions": [
+ "d712357f-97cc-40f8-a095-24ff244d4539"
+ ]
+ }
+ }
+
+The ``UID`` in the ``partitions`` list is an internal reference to the ``obj_id`` in the :ref:`disk config` entries. \ No newline at end of file