aljaz/addons
1
0
Fork 0
mirror of https://github.com/aljazceru/addons.git synced 2025-12-17 13:14:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

samba: Documentation improvements (#866)

Browse Source
This commit is contained in:
Franck Nijhof
2019-12-05 17:55:37 +01:00
committed by GitHub
parent 50c295eee7
commit 43bd5b12fe
1 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
samba/README.md
View File

@@ -1,17 +1,17 @@
# Hass.io Core Add-on: Samba share # Hass.io Core Add-on: Samba share
Share your configuration over the network Share your configuration over the network using Windows file sharing.
![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield] ![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield]
## About ## About
This Add-on allows you to enable file sharing across different operating systems over a network. This Add-on allows you to enable file sharing across different operating systems over a network.
It lets you acess your config files with Windows and macOS devices. It lets you access your config files with Windows and macOS devices.
## Installation ## Installation
The installation of this add-on is straightforward and easy to do. Follow these steps to get the add-on installed on your system:
1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**. 1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
2. Find the "Samba share" add-on and click it. 2. Find the "Samba share" add-on and click it.
@@ -53,21 +53,27 @@ Change WORKGROUP to reflect your network needs.
### Option: `username` (required) ### Option: `username` (required)
The username you would like to use to authenticate with the Samba server.
### Option: `password` (required) ### Option: `password` (required)
The password that goes with the username configured for authentication.
### Option: `interface` (required) ### Option: `interface` (required)
The network interface Samba should listen on for incoming connections.
This option should only be used in advanced cases. In general, setting this
option is not needed.
### Option: `allow_hosts` (required) ### Option: `allow_hosts` (required)
List of hosts/networks allowed to access your configuration. List of hosts/networks allowed to access the shared folders.
### Option: `veto_files` (optional) ### Option: `veto_files` (optional)
List of files that are neither visible nor accessible. Useful to stop clients from littering the share with temporary hidden files (ex: macOS .DS_Store, Windows Thumbs.db) List of files that are neither visible nor accessible. Useful to stop clients
from littering the share with temporary hidden files
## Known issues and limitations (e.g., macOS `.DS_Store` or Windows `Thumbs.db` files)
## Support ## Support