mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Document prerequisites for Webmin integration (#34515)
* Update webmin.markdown Add details about prerequisites (installing XML::Parser), add additional context for user account creation, update phrasing of existing content * Minor tweaks for verbiage, proper markdown * Additional readability improvements for Webmin * Fix odd wording in Webmin account benefits "allows for" might imply that a separate account is automatically more secure; switching to "can allow for" to instead imply that things can be made more granular if desired. * Update source/_integrations/webmin.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Tiny style tweaks --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
a265d92eca
commit
1531885ce7
@ -21,19 +21,50 @@ This {% term integration %} provides sensors for monitoring the CPU and memory u
|
||||
|
||||
## Prerequisites
|
||||
|
||||
For best security, create a specific Webmin user for Home Assistant with a strong password and only "Can accept RPC calls" permission (under "Permissions for all modules") and remove the "Can accept RPC calls" permission for all other users.
|
||||
### Authentication setup
|
||||
|
||||
{% warning %}
|
||||
Always consider your own setup and security needs before exposing services with system-level access.
|
||||
{% endwarning %}
|
||||
|
||||
As a good security practice, create a Webmin User specific to Home Assistant. A dedicated account allows for this integration to operate uninterrupted should you change your primary login for Webmin, and it can allow for more granular access so that only the necessary data and access is made available to Home Assistant.
|
||||
|
||||
#### Suggested User Setup
|
||||
|
||||
- Create the account with a strong password,
|
||||
- Only enable the _"Can accept RPC calls"_ permission (under "Permissions for all modules"),
|
||||
- Consider disabling the _"Can accept RPC calls"_ permission for other users (unless specifically required),
|
||||
- Consider limiting this account to only have access via the IP address of your Home Assistant instance (if appropriate).
|
||||
-
|
||||
|
||||
{% note %}
|
||||
Be aware that the Webmin API ignores any 2FA set up via the frontend, e.g. it is even with enabled 2FA possible to use the API with only username and password.
|
||||
The Webmin API ignores any 2FA set up via the frontend. Even with 2FA enabled, it is still possible to use the API with only a username and password.
|
||||
{% endnote %}
|
||||
|
||||
### Required Webmin Perl Module
|
||||
|
||||
Ensure the `XML::Parser` Perl module is installed via [Webmin Perl Modules](https://webmin.com/docs/modules/perl-modules/) before configuring the integration.
|
||||
|
||||
#### Installing XML::Parser Perl Module
|
||||
|
||||
1. In the Webmin UI, go to **Tools** > **Perl Modules**.
|
||||
2. Under the **Install module** tab, enter `XML::Parser` into the **From CPAN** text field.
|
||||
3. Select **Install** at the bottom of the dialog.
|
||||
4. Confirm that the installation is successful.
|
||||
- If the installation succeeds:
|
||||
- Continue with any remaining steps for Home Assistant.
|
||||
- If the installation fails:
|
||||
- Refer to [Webmin documentation for Perl Modules](https://webmin.com/docs/modules/perl-modules/) to resolve any Webmin issues.
|
||||
- Retry the module installation and confirm that `XML::Parser` is listed on the Perl Modules page under **Existing Modules**.
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Sensors
|
||||
|
||||
**All entities are disabled by default, you need to enable the entities that you wish to use.**
|
||||
{% note %}
|
||||
All entities are **disabled** by default. You must enable any entities that you wish to use.
|
||||
{% endnote %}
|
||||
|
||||
Following sensors will be added:
|
||||
The following sensors are provided:
|
||||
|
||||
- Load (1m)
|
||||
- Load (5m)
|
||||
|
Loading…
x
Reference in New Issue
Block a user