Add documentation for network storage (#27512)

* Add documentation for network storage

* Apply suggestions from code review

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/media_source.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Joakim Sørensen 2023-05-25 12:08:22 +03:00 committed by GitHub
parent 6a08923770
commit 9b728d73e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 92 additions and 5 deletions

View File

@ -28,9 +28,9 @@ The data disk feature can be used on an existing installation without losing dat
1. Connect the data disk to your system. 1. Connect the data disk to your system.
2. Go to **{% my storage title="Settings > System > Storage" %}** in the UI. 2. Go to **{% my storage title="Settings > System > Storage" %}** in the UI.
3. Press the three dots on the top right and choose "Move datadisk" 3. Select the "Move data disk" button.
4. Select the data disk from the list of available devices. 4. Select the data disk from the list of available devices.
5. Press "Move". 5. Select **Move**.
![Screenshot of the "Move datadisk" feature](/images/screenshots/move-datadisk.png) ![Screenshot of the "Move datadisk" feature](/images/screenshots/move-datadisk.png)

View File

@ -0,0 +1,81 @@
## Network storage
You can configure both Network File Share (NFS) and Windows samba (CIFS) targets to be used within Home Assistant and add-ons.
To list all your currently connected network storages, go to **{% my storage title="Settings > System > Storage" %}** in the UI.
{% if page.installation == "os" %}
<div class='note'>
You need to update to Home Assistant Operating System 10.2 before you can use this feature.
</div>
{% endif %}
<p class='img'>
<picture>
<source srcset="/images/screenshots/network-storage/list_dark.png" media="(prefers-color-scheme: dark)">
<img src="/images/screenshots/network-storage/list_light.png">
</picture>
Screenshot of the list of network shares inside the storage panel.
</p>
### Add a new new network storage
1. Go to **{% my storage title="Settings > System > Storage" %}** in the UI.
1. Select **Add network storage**.
1. Fill out all the information for your network storage.
1. Select **Connect**.
<p class='img'>
<picture>
<source srcset="/images/screenshots/network-storage/connect_dark.png" media="(prefers-color-scheme: dark)">
<img src="/images/screenshots/network-storage/connect_light.png">
</picture>
Screenshot of connecting a new network storage.
</p>
#### Network storage configuration
{% configuration_basic "hassio.network_share" %}
Name:
description: This is the name that will be used for the mounted directory on your system.
Usage:
description: Here, you select how the target should be used.
Server:
description: The IP/hostname of the server running NFS/CIFS.
Protocol:
description: The service the server is using for the network storage.
"[NFS]<sup>1</sup> Remote share path":
description: The path used to connect to the remote storage server.
"[CIFS]<sup>2</sup> Username":
description: The username to use when connecting to the storage server.
"[CIFS]<sup>2</sup> Password":
description: The password to use when connecting to the storage server.
"[CIFS]<sup>2</sup> Share":
description: The share to connect to on the storage server.
{% endconfiguration_basic %}
<sup>1</sup> _Options prefixed with `[NFS]` is only available for NFS targets._<br>
<sup>2</sup> _Options prefixed with `[CIFS]` is only available for CIFS targets._
### Change default backup location
By default, the first network storage of type **Backup** that you add will be set as your default backup target.
If you want to change the default backup target, you can do the following:
1. Go to **{% my backup title="Settings > System > Backups" %}** in the UI.
1. Select the menu in the top right of the screen and select the **Change default backup location** option.
1. In the dialog, there is a single option to set the default backup target.
1. Choose the one you want from the list.
1. Select **Save**.
This list will contain all the network storage targets you have added of usage type **Backup**. It also contains another option to set it back to use `/backup` again.
<p class='img'>
<picture>
<source srcset="/images/screenshots/network-storage/change_backup_dark.png" media="(prefers-color-scheme: dark)">
<img src="/images/screenshots/network-storage/change_backup_light.png">
</picture>
Screenshot of changing the default backup target.
</p>

View File

@ -62,9 +62,13 @@ homeassistant:
recording: /mnt/recordings recording: /mnt/recordings
``` ```
Please note, that the folder must be accessible locally. Home Assistant <div class='note'>
cannot connect to external or remote network shares using this configuration
option. If you want to use media from a network storage, the network storage must first be connected first. Refer to [these instructions on how to connect network storage](/common-tasks/os/#network-storage).
The media from the network storage is then automatically added to the local media browser.
</div>
## Playing media from a Media Source ## Playing media from a Media Source

View File

@ -13,6 +13,7 @@ This section will provide guides to some common tasks and information which you
{% include common-tasks/configuration_check.md %} {% include common-tasks/configuration_check.md %}
{% include common-tasks/file_access.md %} {% include common-tasks/file_access.md %}
{% include common-tasks/backups.md %} {% include common-tasks/backups.md %}
{% include common-tasks/network_storage.md %}
{% include common-tasks/commandline.md %} {% include common-tasks/commandline.md %}
{% include common-tasks/lost_password.md %} {% include common-tasks/lost_password.md %}
{% include common-tasks/third-party-addons.md %} {% include common-tasks/third-party-addons.md %}

View File

@ -11,6 +11,7 @@ installation_name: Supervised
{% include common-tasks/configuration_check.md %} {% include common-tasks/configuration_check.md %}
{% include common-tasks/file_access.md %} {% include common-tasks/file_access.md %}
{% include common-tasks/backups.md %} {% include common-tasks/backups.md %}
{% include common-tasks/network_storage.md %}
{% include common-tasks/commandline.md %} {% include common-tasks/commandline.md %}
{% include common-tasks/lost_password.md %} {% include common-tasks/lost_password.md %}
{% include common-tasks/third-party-addons.md %} {% include common-tasks/third-party-addons.md %}

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB