Improve backup location related parts in Synology DSM docs (#37212)

* improve backup location related docs

* fix links

* add Backup category

* add file station example

* tiny style tweaks

* Update source/_integrations/synology_dsm.markdown

* Update source/_integrations/synology_dsm.markdown

* Update source/_integrations/synology_dsm.markdown

* Update source/_integrations/synology_dsm.markdown

* Apply suggestions from code review

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Michael 2025-01-31 08:50:18 +01:00 committed by Franck Nijhof
parent cf6d3636cd
commit 04160f98a1
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
2 changed files with 24 additions and 1 deletions

View File

@ -2,6 +2,7 @@
title: Synology DSM
description: Instructions on how to integrate the Synology DSM sensor within Home Assistant.
ha_category:
- Backup
- Camera
- Media source
- System monitor
@ -52,7 +53,7 @@ When creating the user, it is possible to deny access to all locations and appli
If you want to add cameras from [Surveillance Station](https://www.synology.com/surveillance), the user needs application permission for [Surveillance Station](https://www.synology.com/surveillance).
If you want to use a shared folder from the [File Station](https://www.synology.com/en-us/dsm/feature/file_sharing) as {% term backup %} location, the user needs application permission for [File Station](https://www.synology.com/en-us/dsm/feature/file_sharing) and read/write permissions on the specific shared folder.
If you want to use a shared folder from the [File Station](https://www.synology.com/en-us/dsm/feature/file_sharing) as {% term backup %} location, the user needs application permission for [File Station](https://www.synology.com/en-us/dsm/feature/file_sharing) and read/write permissions on the specific [shared folder](https://kb.synology.com/en-us/DSM/help/DSM/AdminCenter/file_share_desc).
### If you utilize 2-Step Verification or Two Factor Authentication (2FA) with your Synology NAS
@ -64,6 +65,28 @@ Make sure to log out of your "normal" user's account and then login with the sep
If you denied access to all locations and applications it is normal to receive a message indicating you do not have access to DSM when trying to login with this separate user. As noted above, you do not need access to the DSM and Home Assistant will still be able to read statistics from your NAS.
{% endnote %}
## Backup location
The NAS can also be used as a {% term backup %} location, without the need to add the NAS as a network drive to Home Assistant. For this you need to setup the correct permissions for the user (_see [Separate User Configuration](#separate-user-configuration) above_), afterwards, you will be able to select the shared folder and define a relative path to be used as a backup location in the integration options ({% my integrations title="**Settings** > **Devices & services**" %} > **Synology DSM** > _select the instance_ > **Configure**)
### Example
Assume there is a shared folder called `HA Backup`, with two directories in it `productive_instance` and `test_instance`.
<img src="/images/integrations/synology_dsm/synology_file_station.png" />
#### Use an existing path
1. Select `HA Backup` as shared folder.
2. Define `productive_instance` as backup path (_without trailing slash_).
- **Result**: The existing `productive_instance` will be used as backup location.
#### Use a non-existing path
1. Select `HA Backup` as a shared folder.
2. Define `cottage_instance` as backup path (_without trailing slash_).
- **Result**: A new directory `cottage_instance` will be created on the shared folder `HA Backup` during the first backup.
## Sensors
### CPU utilization sensors

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB