mirror of
https://github.com/aljazceru/addons.git
synced 2025-12-17 13:14:21 +01:00
Create README.md (#739)
This is a first draft of the Readme for review not sure what is required and what isn't please let me know if I'm missing something
This commit is contained in:
committed by
Pascal Vizeli
parent
d898650e8e
commit
2659b2453a
88
samba/README.md
Normal file
88
samba/README.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
# Hass.io Core Add-on: Samba share
|
||||||
|
|
||||||
|
Share your configuration over the network
|
||||||
|
|
||||||
|
![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
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The installation of this add-on is straightforward and easy to do.
|
||||||
|
|
||||||
|
1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
|
||||||
|
2. Find the "Samba sahre" add-on and click it.
|
||||||
|
3. Click on the "INSTALL" button.
|
||||||
|
|
||||||
|
## How to use
|
||||||
|
|
||||||
|
In the configuration section, define a username and password and save teh configuratione
|
||||||
|
|
||||||
|
|
||||||
|
1. Start the add-on.
|
||||||
|
2. Have some patience and wait a couple of minutes.
|
||||||
|
3. Check the add-on log output to see the result.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Add-on configuration:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"workgroup": "WORKGROUP",
|
||||||
|
"username": "Hassio",
|
||||||
|
"password": "null",
|
||||||
|
"interface": "",
|
||||||
|
"allow_hosts": [
|
||||||
|
"10.0.0.0/8",
|
||||||
|
"172.16.0.0/12",
|
||||||
|
"192.168.0.0/16"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option: `workgroup` (required)
|
||||||
|
|
||||||
|
Change WORKGROUP to reflect your network needs.
|
||||||
|
|
||||||
|
### Option: `username` (required)
|
||||||
|
|
||||||
|
|
||||||
|
### Option: `password` (required)
|
||||||
|
|
||||||
|
|
||||||
|
### Option: `interface` (required)
|
||||||
|
### Option: `allow_hosts` (required)
|
||||||
|
|
||||||
|
List of hosts/networks allowed to access your configuration.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Known issues and limitations
|
||||||
|
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
Got questions?
|
||||||
|
|
||||||
|
You have several options to get them answered:
|
||||||
|
|
||||||
|
- The [Home Assistant Discord Chat Server][discord].
|
||||||
|
- The Home Assistant [Community Forum][forum].
|
||||||
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
||||||
|
|
||||||
|
In case you've found an bug, please [open an issue on our GitHub][issue].
|
||||||
|
|
||||||
|
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||||
|
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||||
|
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||||
|
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||||
|
[discord]: https://discord.gg/c5DvZ4e
|
||||||
|
[forum]: https://community.home-assistant.io
|
||||||
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||||
|
[issue]: https://github.com/home-assistant/hassio-addons/issues
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[repository]: https://github.com/hassio-addons/repository
|
||||||
Reference in New Issue
Block a user