Updated documentation
This commit is contained in:
parent
fe1df5a28c
commit
28ec32dbbb
45
README.md
45
README.md
@ -10,14 +10,51 @@ An Ansible role for setting up Samba as a file server. Specifically, the respons
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
SELinux is expected to be running and the firewall should be active.
|
- SELinux is expected to be running
|
||||||
|
- The firewall should be active
|
||||||
|
- Samba users should already exist as system users
|
||||||
|
|
||||||
|
You can take a look at role [bertvv.el7](https://galaxy.ansible.com/list#/roles/2305) that does all this and more.
|
||||||
|
|
||||||
## Role Variables
|
## Role Variables
|
||||||
|
|
||||||
|
|
||||||
| Variable | Required | Default | Comments (type) |
|
| Variable | Required | Default | Comments |
|
||||||
| :--- | :--- | :--- | :--- |
|
| :--- | :--- | :--- | :--- |
|
||||||
| `role_var` | no | - | (scalar) PURPOSE |
|
| `samba_create_varwww_symlinks` | no | - | When this is set to `yes`, symlinks are created in `/var/www/html` to the shares. |
|
||||||
|
| `samba_load_homes` | no | no | Make user home directories accessible. |
|
||||||
|
| `samba_load_printers` | no | no | Make printers accessible. |
|
||||||
|
| `samba_log` | no | - | Set the log file. If left undefined, logging is done through syslog. |
|
||||||
|
| `samba_log_size` | no | 5000 | Set the maximum size of the log file. |
|
||||||
|
| `samba_map_to_guest` | no | `bad user` | Behaviour when unregistered users access the shares. |
|
||||||
|
| `samba_netbios_name` | yes | - | The NetBIOS name of this server. |
|
||||||
|
| `samba_passdb_backend` | no | `tdbsam` | Password database backend. |
|
||||||
|
| `samba_security` | no | `user` | Samba security setting |
|
||||||
|
| `samba_server_string` | no | `fileserver %m` | Comment string for the server. |
|
||||||
|
| `samba_shares` | no | - | List of dicts containing share definitions. See below for details. |
|
||||||
|
| `samba_shares_root` | no | `/srv/shares` | Directories for the shares are created under this directory. |
|
||||||
|
| `samba_users` | no | - | List of dicts defining users that can access shares. |
|
||||||
|
| `samba_workgroup` | no | `WORKGROUP` | Name of the server workgroup. |
|
||||||
|
|
||||||
|
### Defining users
|
||||||
|
|
||||||
|
In order to allow users to access the shares, they need to get a password specifically for Samba:
|
||||||
|
|
||||||
|
```Yaml
|
||||||
|
samba_users:
|
||||||
|
- name: alice
|
||||||
|
password: ecila
|
||||||
|
- name: bob
|
||||||
|
password: bob
|
||||||
|
- name: charlie
|
||||||
|
password: eilrahc
|
||||||
|
```
|
||||||
|
|
||||||
|
Unfortunately, passwords have to be in plain text for now.
|
||||||
|
|
||||||
|
### Defining shares
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user