diff --git a/index.md b/index.md new file mode 100644 index 0000000..0e7582f --- /dev/null +++ b/index.md @@ -0,0 +1,56 @@ +--- +title: smb +type: docs +--- + +[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.smb/status.svg)](https://drone.rknet.org/ansible/xoxys.smb) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![Source Code](https://img.shields.io/badge/Git-Source%20code-blue?logo=git)](https://gitea.rknet.org/ansible/xoxys.smb) + +Mount a list of smb shares. + +* [Default Variables](#default-variables) + * [smb_packages](#smb-packages) + * [smb_shares](#smb-shares) +* [Dependencies](#dependencies) + +--- + +## Default Variables + +### smb_packages + +#### Default value + +```YAML +smb_packages: + - cifs-utils +``` + +### smb_shares + +Add mount defined samba shares. You can specify samba credentials with username/password parameter. Credentials will be used in a credentials file and saved to `/root/.smbcredentials/` and not in the fstab directly. + +#### Default value + +```YAML +smb_shares: [] +``` + +#### Example usage + +```YAML +smb_shares: + - name: multimedia + source: //share.example.com/media + username: myuser + password: secure + mountpoint: /media/data + mountopts: + - acl + - uid=1000 + - gid=1000 + state: mounted +``` + +## Dependencies + +None.