Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

vsftpd

LINUX-VSFTPD
Project URLRSS FeedReport issues

12,266 downloads

9,294 latest version

2.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.2.6 (latest)
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0 (deleted)
released Jun 7th 2015

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'alexggolovin-vsftpd', '0.2.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add alexggolovin-vsftpd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install alexggolovin-vsftpd --version 0.2.6

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: ftp, vsftpd, alexggolovin

Documentation

alexggolovin/vsftpd — version 0.2.6 Jun 7th 2015

Table of Contents

  1. Default Usage
  2. Description
  3. Classes
  4. Folders
  5. Permissions
  6. Supported OS
  7. Usage
  8. Hiera Examples

###Default Usage VSFTPD server configured for public anonymous and real system users authenticated by passwords in their home folders only usage.

###Description: This is complex module example which allows deploy and configure vsftpd service for virtual or local system users with allowed for download and upload permissions into their own home folders, anonymous configured users restricted access for download only from '/var/ftp' folder with possible managed this folder's content by this module with next variety of supported OS: CentOS/RedHat/Ubuntu/Debian.

Classes

  • Class vsftpd This class installs and configure vsftpd service;
  • Class ::vsftpd::params This class responsible for OS depend parameters and vsftpd.conf configuration file options. For virtual and real users authentication: vsftpd.conf.erb and vsftpd_virt.conf.erb assigned via ::vsftpd::params class;

###Folders

  • Virtual users home folder '/home/virtual' for all users from Berkley database;
  • Anonymous content folder '/var/ftp' created with help of ::vsftpd::content included class;

###Permissions: Anonymous '/var/ftp' download only, local/virtual users: download/upload into their home folders only;

###Supported OS:

  • Debian-8/Ubuntu-14/CentOS-7/RedHat-7 - full supported distributions;
  • Debian-7,CentOS-6,RedHat-6 releases can be used for anonymous downloads only, because seems they don't work with "allow_writeable_chroot" option;

###Usage: To change vsftpd service configurations edit vsftpd class parameters like "$listen" in the init.pp file, or add/remove required options directly into templates/vsftpd.conf.erb for real system's users and templates/vsftpd_virt.conf.erb for virtual user's configuration files. To get it started just add class {'vsftpd':} into site.pp configuration file for nodes where vsftpd server must be installed.

1.Add class {'vsftpd':} into site.pp configuration file for nodes where vsftpd server must be installed

2.Real system users authentication usage configured by default via init.pp class parameter "$enable_virtual = 'NO'".

3.If you want to change default system authentication to virtual users authentication you have to:

3.1 To be sure hiera is installed on your puppet master server, usually it's already installed by default as a part of puppet;

3.2 Add new "-vsftpd" hierarchy in /etc/puppet/hiera.yaml Example:

      ---
       :backends:
        - yaml
       :yaml:
        :datadir: /etc/puppet/hiera
       :hierarchy:
        -vsftpd

3.3 Configure your hiera datasource with required user/password values for Berkley DB: Example: /etc/puppet/hiera/vsftpd.yaml user,password,user,password line by line;

      ---
       vsftpd::ftpuser:
        - alex
        - mytopsecretpass
        - mike
        - mikespasssecret

3.4 Change init.pp class parameter "$enable_virtual = 'NO'" to "$enable_virtual = 'YES'"

3.5 Security notes: don't forget to change your /etc/puppet/hiera/vsftpd.yaml secret password file access permissions.

###Hiera Examples: hiera_examples module folder contains: hiera.yaml - hiera configuration file example; vsftpd.yaml - virtual users usernames and passwords database example;