public_git
/
pikvm
mirror of https://github.com/pikvm/pikvm.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update

This commit is contained in:
Maxim Devaev 2025-07-23 16:13:20 +03:00
parent 257bcb7286
commit 750b445747
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/_config.md
View File

@ -6,15 +6,25 @@ search:
??? note "Configuring PiKVM OS"
The following is a brief guide to configuring PiKVM. For more information (including the basics of YAML syntax and how to use a text editor in the Linux console), please refer to [this page](config.md).
!!! tip "Need more info? We have it!"
The following is a brief guide to configuring PiKVM.
For more information (including the basics of YAML syntax and how to use a text editor in the Linux console),
please refer to [this page](config.md).
Most of the PiKVM configuration files are located in the `/etc/kvmd` directory.
The `/etc/kvmd/main.yaml` file defines the platform config and **you should never edit it**. To redefine system parameters use the file `/etc/kvmd/override.yaml`. All other files that are also not recommended for editing have read-only permissions. You can also create several files with the `.*yaml` extension and put then into `/etc/kvmd/override.d` directory to split your customization into logical parts. The `override.yaml` file definitions takes precedence over the `override.d` directory.
The `/etc/kvmd/main.yaml` file defines the platform config and **you should never edit it**.
To redefine system parameters use the file `/etc/kvmd/override.yaml`.
All other files that are also not recommended for editing have read-only permissions.
You can also create several files with the `.*yaml` suffix and put then into `/etc/kvmd/override.d` directory
to split your customization into logical parts.
The `override.yaml` file definitions takes precedence over the `override.d` directory.
A complete list of all parameters can be viewed using the `kvmd -m` command.
Files with the suffix `*.yaml` uses the [YAML syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html)
Files with the `*.yaml` suffix uses the [YAML syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html)
and describes a parameter tree with key-value pairs of different types.
To define the parameters within one section, an indent of 4 spaces is used.
Comments starts with the `#` symbol.