RomanNum3ral
/
archinstall
mirror of https://github.com/archlinux/archinstall.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

guided.rst: fix formatting & typos (#3235)

This commit is contained in:
Carlo Teubner 2025-03-09 09:57:56 +00:00 committed by GitHub
parent c9ebf3c881
commit 24f479892f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 167 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

334
docs/installing/guided.rst
View File

@ -53,168 +53,168 @@ The contents of :code:`https://domain.lan/config.json`:
.. code-block:: json .. code-block:: json
{ {
"additional-repositories": [], "additional-repositories": [],
"archinstall-language": "English", "archinstall-language": "English",
"audio_config": null, "audio_config": null,
"bootloader": "Systemd-boot", "bootloader": "Systemd-boot",
"debug": false, "debug": false,
"disk_config": { "disk_config": {
"config_type": "manual_partitioning", "config_type": "manual_partitioning",
"device_modifications": [ "device_modifications": [
{ {
"device": "/dev/sda", "device": "/dev/sda",
"partitions": [ "partitions": [
{ {
"btrfs": [], "btrfs": [],
"flags": [ "flags": [
"boot" "boot"
], ],
"fs_type": "fat32", "fs_type": "fat32",
"length": { "length": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 99982592 "value": 99982592
}, },
"mount_options": [], "mount_options": [],
"mountpoint": "/boot", "mountpoint": "/boot",
"obj_id": "369f31a8-2781-4d6b-96e7-75680552b7c9", "obj_id": "369f31a8-2781-4d6b-96e7-75680552b7c9",
"start": { "start": {
"sector_size": { "sector_size": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 512 "value": 512
}, },
"total_size": null, "total_size": null,
"unit": "sectors", "unit": "sectors",
"value": 34 "value": 34
}, },
"status": "create", "status": "create",
"type": "primary" "type": "primary"
}, },
{ {
"btrfs": [], "btrfs": [],
"flags": [], "flags": [],
"fs_type": "fat32", "fs_type": "fat32",
"length": { "length": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 100000000 "value": 100000000
}, },
"mount_options": [], "mount_options": [],
"mountpoint": "/efi", "mountpoint": "/efi",
"obj_id": "13cf2c96-8b0f-4ade-abaa-c530be589aad", "obj_id": "13cf2c96-8b0f-4ade-abaa-c530be589aad",
"start": { "start": {
"sector_size": { "sector_size": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 512 "value": 512
}, },
"total_size": { "total_size": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 16106127360 "value": 16106127360
}, },
"unit": "MB", "unit": "MB",
"value": 100 "value": 100
}, },
"status": "create", "status": "create",
"type": "primary" "type": "primary"
}, },
{ {
"btrfs": [], "btrfs": [],
"flags": [], "flags": [],
"fs_type": "ext4", "fs_type": "ext4",
"length": { "length": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 15805127360 "value": 15805127360
}, },
"mount_options": [], "mount_options": [],
"mountpoint": "/", "mountpoint": "/",
"obj_id": "3e75d045-21a4-429d-897e-8ec19a006e8b", "obj_id": "3e75d045-21a4-429d-897e-8ec19a006e8b",
"start": { "start": {
"sector_size": { "sector_size": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 512 "value": 512
}, },
"total_size": { "total_size": {
"sector_size": null, "sector_size": null,
"total_size": null, "total_size": null,
"unit": "B", "unit": "B",
"value": 16106127360 "value": 16106127360
}, },
"unit": "MB", "unit": "MB",
"value": 301 "value": 301
}, },
"status": "create", "status": "create",
"type": "primary" "type": "primary"
} }
], ],
"wipe": false "wipe": false
} }
] ]
}, },
"disk_encryption": { "disk_encryption": {
"encryption_type": "luks", "encryption_type": "luks",
"partitions": [ "partitions": [
"3e75d045-21a4-429d-897e-8ec19a006e8b" "3e75d045-21a4-429d-897e-8ec19a006e8b"
] ]
}, },
"hostname": "archlinux", "hostname": "archlinux",
"kernels": [ "kernels": [
"linux" "linux"
], ],
"locale_config": { "locale_config": {
"kb_layout": "us", "kb_layout": "us",
"sys_enc": "UTF-8", "sys_enc": "UTF-8",
"sys_lang": "en_US" "sys_lang": "en_US"
}, },
"mirror_config": { "mirror_config": {
"custom_servers": [ "custom_servers": [
{ {
"url": "https://mymirror.com/$repo/os/$arch" "url": "https://mymirror.com/$repo/os/$arch"
} }
], ],
"mirror_regions": { "mirror_regions": {
"Australia": [ "Australia": [
"http://archlinux.mirror.digitalpacific.com.au/$repo/os/$arch" "http://archlinux.mirror.digitalpacific.com.au/$repo/os/$arch"
] ]
}, },
"optional_repositories": [ "optional_repositories": [
"testing" "testing"
], ],
"custom_repositories": [ "custom_repositories": [
{ {
"name": "myrepo", "name": "myrepo",
"url": "https://myrepo.com/$repo/os/$arch", "url": "https://myrepo.com/$repo/os/$arch",
"sign_check": "Required", "sign_check": "Required",
"sign_option": "TrustAll" "sign_option": "TrustAll"
} }
] ]
}, },
"network_config": {}, "network_config": {},
"no_pkg_lookups": false, "no_pkg_lookups": false,
"ntp": true, "ntp": true,
"offline": false, "offline": false,
"packages": [], "packages": [],
"parallel downloads": 0, "parallel downloads": 0,
"profile_config": null, "profile_config": null,
"save_config": null, "save_config": null,
"script": "guided", "script": "guided",
"silent": false, "silent": false,
"swap": true, "swap": true,
"timezone": "UTC", "timezone": "UTC",
"version": "2.6.0" "version": "2.6.0"
} }
``--config`` options ``--config`` options
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -250,7 +250,7 @@ Below is an example of how to set the root password and below that are descripti
"!root-password" : "SecretSanta2022" "!root-password" : "SecretSanta2022"
} }
.. list-table:: --creds options .. list-table:: ``--creds`` options
:widths: 25 25 40 10 :widths: 25 25 40 10
:header-rows: 1 :header-rows: 1
@ -258,15 +258,15 @@ Below is an example of how to set the root password and below that are descripti
- Values - Values
- Description - Description
- Required - Required
* - !encryption-password * - ``!encryption-password``
- ``str`` - ``str``
- Password to encrypt disk, not encrypted if password not provided - Password to encrypt disk, not encrypted if password not provided
- No - No
* - !root-password * - ``!root-password``
- ``str`` - ``str``
- The root account password - The root account password
- No - No
* - !users * - ``!users``
- .. code-block:: json - .. code-block:: json
{ {
@ -284,7 +284,7 @@ Below is an example of how to set the root password and below that are descripti
.. note:: .. note::
The key's start with ``!`` because internal log functions will mask any keys starting with explamation from logs and unrestricted configurations. The keys start with ``!`` because internal log functions will mask any keys starting with exclamation marks from logs and unrestricted configurations.
.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts .. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
.. _Guided Installer: https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py .. _Guided Installer: https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py