cookbook 'samba', '= 1.2.1'
samba
(35) Versions
1.2.1
-
Follow16
Installs/Configures samba
cookbook 'samba', '= 1.2.1', :supermarket
knife supermarket install samba
knife supermarket download samba
Samba Cookbook
Installs and configures Samba client or server.
Maintainers
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.
Requirements
Platforms
- Debian / Ubuntu derivatives
- RedHat and derivatives
If you would like support for your preferred platform. Please think about creating a Vagrant Box and adding test platforms
Chef
- Chef 12.15+
Known Limitations
- Does not integrate with LDAP/AD.
- Uses plaintext passwords for the user resource to create the SMB users if the password backend is tdbsam or smbpasswd. See below under usage.
- Creates & manages the system user. The creation of the user is the trigger for smbpasswd.
Recipes
client
Installs the samba client to provide access to SMB shares.
server
Sets up a Samba server. See below for more information on configurables.
Resources
User
This cookbook includes a resource/provider for managing samba users with the smbpasswd program. It will create the users home directory, and manage the user.
The creation of the user is the trigger for smbpasswd management.
The basis of this resource is the Core [user resource].
samba_user 'jtimberman' do password 'plaintextpassword' # user password for samba and the system comment 'user_name_comment' home '/home/jtimberman' # Users home. shell '/bin/zsh' # User shell to set, e.g. /bin/sh, /sbin/nologin manage_home true # true/false, whether to manage the users home directory location end
This resource can only create, enable or delete the user. It only supports setting the user's initial password. It assumes a password db backend that utilizes the smbpasswd program.
This will enforce the user system password set by the resource.
Server
samba_server 'samba server' do workgroup # The SMB workgroup to use, default "SAMBA". interfaces # Interfaces to listen on, default "lo 127.0.0.1". hosts_allow # Allowed hosts/networks, default "127.0.0.0/8". bind_interfaces_only # Limit interfaces to serve SMB, default "no" load_printers # Whether to load printers, default "no". passdb_backend # Which password backend to use, default "tdbsam". dns_proxy # Whether to search NetBIOS names through DNS, default "no". security # Samba security mode, default "user". map_to_guest # What Samba should do with logins that don't match Unix users, default "Bad User". socket_options # Socket options, default "`TCP_NODELAY`" config_file # Location of Samba configuration, see resource for platform default log_dir # Location of Samba logs, see resource for platform default realm # Kerberos realm to use, default: '' password_server # Use a specific remote server for auth, default: '' encrypt_passwords # Whether to negotiate encrypted passwords, default: yes kerberos_method # How kerberos tickets are verified, default: secrets only log_level # Sets the logging level from 0-10, default: 0 winbind_separator # Define the character used when listing a username of the form of DOMAIN \user, default \ idmap_config # Define the mapping between SIDS and Unix users and groups, default: none max_log_size # Maximum log file size, default: 5000, (5MB) options # list of additional options, e.g. 'unix charset' => 'UTF8'. end
Share
samba_share 'Share Name' do comment guest_ok # yes, no printable # yes, no write_list # An array of Unix users create_mask # e.g. 0644 directory_mask # e.g. 0700 read_only # yes, no, default no create_directory # Whether to create the directory being served, default true valid_users # space separated users or group, default '' force_group # Assign Unix group as default primary, default '' browseable # yes, no default: yes options # list of additional options, e.g. 'inherit permissions' => 'yes' path # String for the path of directory to be served. Required. end
Usage
The samba::default
recipe includes samba::client
, which simply installs smbclient package.
Create a cookbook with the server
, user
& share
resources as if you were using any other Chef resource.
For examples see the test/fixtures/cookbooks/test
directory.
Unfortunately, smbpasswd does not take a hashed password as an argument - the password is echoed and piped to the smbpasswd program. This is a limitation of Samba.
Contributors
This project exists thanks to all the people who contribute.
Backers
Thank you to all our backers!
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
Samba Changelog
v1.2.1 (20-03-2020)
- Fix: no longer ignore log_level in the server options
- Add CircleCI builder
- Remove unnecessary
if respond_to?(:chef_version)
in the metadata.rb - Remove unnecessary
require 'mixlib/shellout'
from the user resource - Simplify overly complex platform logic
- Swap Debian 8 testing for Debian 10
- Add CentOS 8 to the kitchen config
- Remove the .rubocop.yml config that only had a Dangerfile exclusion
- Migrate to actions
v1.2.0 (2018-09-22)
- Update platforms
- Remove shaddow password test that was unreliable
- Drop Chef-12 support
v1.1.4 (2018-07-22)
- Fix bind interfaces
v1.1.3 (2018-06-05)
- Honour the
max_size
property (#84, @sll552)
v1.1.2 (2018-03-28)
- Make the password property sensitive so it doesn't appear in the output log (#83)
v1.1.1 (2017-12-06)
- Add optional, options to the share resource (#80)
v1.1.0 (2017-08-02)
- Add realm property
- Add encrypt_passwords property
- Add kerberos_method property
- Add log_level property
- Add winbind_separator property
- Add idmap_config property
- Add valid_users property
- Add force_group property
- Add browseable property
- Many rubocop fixes (though not all)
- Change share options from required that weren't really required
- Fix issue with directory creation when path was not defined (which is not required for home dirs for instance)
- Make winbind_separator optional in template as default backslash is a continuation character in smb.conf
- Extend tests
v1.0.6 (2017-07-24)
- Require Chef 12.16+ #73
- Update README with clear intentions of the
samba_user
resource. # - Fix OpenSUSE client install #75
v1.0.5 (2017-04-21)
- Fix user resource to generate a correct user password.
- Fix options Hash #66
v1.0.4 (2017-04-06)
- Add
read_only
option to share. (#62 @whatcould)
v1.0.3 (2017-02-25)
- Fixes double converges for smb.conf
- Remove 16.04 from travis test matrix whilst we investigate long term solutions to failures
- Adds Service tests
- Remove ChefSpec matchers to tidy for tidy up
v1.0.2 (2017-04-02)
- Fix #54 Add an option to not create the directory we add to the share. Useful for including Samba variables in the share name.
- Fix #52 nmbd systemd failures in tests.
v1.0.1 (2017-04-02)
- Fix #48 Resource underscores breaking permissions
- Fix #47 Document proper behaviour of smbpasswd. This cookbook now enforces passwords.
v1.0.0 (2017-01-03)
- New custom resources
samba_server
,samba_share
,samba_user
- Remove data bags!
- Removed support for Arch & SmartOS
- Add 12.1 compatibility requirement
- Move attributes out of template file and into template resource
- Use Chef built in apt-get functionality
- Remove default recipe - having a default recipe can be misleading when it doesn't do anything.
- Guard against nil options & shares
- Update README with resources and give it a general tidy.
- Remove default specs
- Use root context for template and services
- Use trusty not precise for building on travis-ci
- Remove spec directory as it duplicates inspec test & doesn't test what's now in the cookbook
- Move yum into the testing recipe to clean up dependancies.
- Ignore FC009 as it isn't being picked up correctly.
v0.13.0 (2016-12-30)
- This cookbook is now maintained by Sous Chefs (sous-chefs.org). Expect regular updates and quicker turnaround on PRs!
- This will be the last version of this cookbook that supports Chef 11. Pin to this version if you require Chef 11 compatibility
- Added node["samba"]["options"] for passing an array of additional options
- Added node['samba']['enable_users_search'] to enable/disable searching for samba users. Defaults to true to maintain existing behavior.
- Added SmartOS compatibility
- Added ChefSpec matchers for the LWRP
- Added
source_url
issues_url
andchef_version
metadata - Removed arch and raspbian from the metadata and added oracle. We officially support systems we can test with Test Kitchen only.
- Added a Rakefile for simplified testing
- Switched integration testing to Inspec from serverspec
- Moved all testing to the 'test' cookbook and eliminated the need for the apt cookbook
- Switched to cookstyle from Rubocop and resolved all warnings
- Added testing in Travis CI
- Added a kitchen config for kitchen-dokken. Expect testing in Travis using kitchen-dokken soon
- Added a Code of Conduct doc
- Updated the Contributing docs
v0.12.0
- Manage services at end of server recipe
- Move package and service names to attributes
- Select data bags via attributes instead of hardcoded names
- Corrected service name on Debian
- Add map to guest option in smb.conf
- Add test kitchen, chefspec, serverspec, rubocop ignore rules, and foodcritic check
- Cleanup attributes to make them easier to follow per-platform
v0.11.4
Bug
- [COOK-3144]: Wrong service name in samba cookbook
v0.11.2
Bug
- [COOK-2978]: samba cookbook has foodcritic errors
v0.11.0
- [COOK-1719] - Add Scientific / Amazon support to the Samba recipe
v0.10.6
- [COOK-1363] - user password assignment fails on systems using dash as default shell
v0.10.4
- Fixes COOK-802, typo in nmbd service name
Collaborator Number Metric
1.2.1 passed this metric
Contributing File Metric
1.2.1 passed this metric
Foodcritic Metric
1.2.1 passed this metric
No Binaries Metric
1.2.1 passed this metric
Testing File Metric
1.2.1 passed this metric
Version Tag Metric
1.2.1 passed this metric
1.2.1 passed this metric
1.2.1 passed this metric
Foodcritic Metric
1.2.1 passed this metric
No Binaries Metric
1.2.1 passed this metric
Testing File Metric
1.2.1 passed this metric
Version Tag Metric
1.2.1 passed this metric
1.2.1 passed this metric
1.2.1 passed this metric
Testing File Metric
1.2.1 passed this metric
Version Tag Metric
1.2.1 passed this metric
1.2.1 passed this metric
1.2.1 passed this metric