Puppet script for provisioning my FreeBSD desktop workstation.

• Setup
• Prerequisites
  • System dependencies
  • Puppet dependencies
• Usage
• Manifests
• Limitations

First, you need to get the latest source code by cloning the git repository with this command.

git clone https://github.com/lognoz/puppet-freebsd-workstation.git

Finally, change to the directory that was just created.

cd puppet-freebsd-workstation

You must be run as root and have an internet connection. You can install the dependencies with this command line:

make dependencies

git
Distributed source code management tool

puppet7
Configuration management framework written in Ruby

puppet-archive
Compressed archive file download and extraction with native types/providers for Windows and Unix

puppet-nodejs
Install Node.js package and npm package provider.

puppet-php
Generic PHP module that supports many platforms

puppetlabs-apache
Installs, configures, and manages Apache virtual hosts, web services, and modules.

puppetlabs-mysql
Installs, configures, and manages the MySQL service.

puppetlabs-stdlib
Standard library of resources for Puppet modules.

puppetlabs-vcsrepo
Puppet module providing a type to manage repositories from various version control systems

rehan-wget
Install, manage and configure wget and retrieve files using it

saz-sudo
Manage sudo configuration via Puppet

saz-timezone
Manage timezone settings via Puppet

Create your own site.pp at base path:

touch site.pp

You can read example.pp located to base path to help building your own site node.
Add to your file the user that will lead your workstation:

class { 'workstation':
  username => 'john',
  owner_name => 'John Doe',
  owner_email => '[email protected]',
  timezone => 'America/New_York',
  password => 'default'
}

Finally, apply your site file by executing this command. Be carful this will replace directory
located at /usr/local/etc/puppet/modules/workstation/.

make

• workstation
• workstation::alsamixer
• workstation::bash::alias
• workstation::bash::bin
• workstation::bash::init
• workstation::bash::rc
• workstation::doas
• workstation::fonts
• workstation::gnu
• workstation::graphic
• workstation::keyboard
• workstation::language
• workstation::multimedia::firefox
• workstation::multimedia::graphic
• workstation::multimedia::torrent
• workstation::multimedia::wget
• workstation::multimedia::youtube_dl
• workstation::optimization
• workstation::package
• workstation::powerd
• workstation::programming::hacking
• workstation::programming::latex
• workstation::programming::lisp::clisp
• workstation::programming::python
• workstation::programming::virtualisation
• workstation::programming::www::apache
• workstation::programming::www::mysql
• workstation::programming::www::npm
• workstation::programming::www::php
• workstation::security
• workstation::sudo
• workstation::system
• workstation::tor
• workstation::user::directories
• workstation::user::emacs
• workstation::user::git
• workstation::user::vim
• workstation::x11::conf
• workstation::x11::dwm
• workstation::x11::xorg

This class sets root and user for FreeBSD systems. Make sure to load
this file before any workstation subclasses.

class { 'workstation':  
  username => 'lognoz',  
  owner_name => 'Marc-Antoine Loignon',  
  owner_email => '[email protected]',  
  timezone => 'America/New_York',  
  password => $password  
}

This class initialize alsamixer package. This program is a graphical
mixer program for the Advanced Linux Sound Architecture that is used
to configure sound settings and adjust the volume.

include workstation::alsamixer

This module manages bash aliases configurations.

workstation::bash::alias { [  
  'ls="ls -F"',  
  'll="ls -lah"',  
  'emacs="emacs --maximized"'  
]: }

This module manages bash executable.

workstation::bash::bin { 'torrent':  
  content => template('workstation/bin/torrent.erb')  
}

This class install bash and some useful configurations.

include workstation::bash::init

This module manages bashrc configurations.

workstation::bash::rc {  
  'alias ls="ls -F"':  
}

This class sets doas package. This program allows a regular user to
run commands as another user (usually root).

include workstation::doas

This class install system fonts.

include workstation::fonts

This class install GNU utils and libraries like gmake, ripgrep,
gls, gcc, etc.

include workstation::gnu

This class add graphics support to make FreeBSD usable as a desktop.
It only supports Intel HD and NVIDIA graphics cards.

class { 'workstation::graphic':  
  hardware => 'nvidia'  
}

This class sets keyboard in xorg. For each input device (keyboard,
mouse, etc.) it need an InputClass section.

class { 'workstation::keyboard':  
  keyboard => 'us,ca'  
}

This class help to manage multiple languages keyboard and language
tool program.

class { 'workstation::language':  
  aspell => ['en','fr']  
}

This class initialize Firefox package. This program, also known as
Mozilla Firefox, is a free and open-source web browser developed by
the Mozilla Foundation and its subsidiary, the Mozilla Corporation.

class { 'workstation::multimedia::firefox':  
  extensions => [  
    '3679754/ublock_origin-1.31.0-an+fx.xpi',  
    '3679479/https_everywhere-2020.11.17-an+fx.xpi',  
    '3690660/user_agent_switcher-1.4.1-an+fx.xpi',  
    '3672658/decentraleyes-2.0.15-an+fx.xpi',  
    '3682334/clearurls-1.20.0-an+fx.xpi',  
    '3691752/noscript_security_suite-11.1.6-an+fx.xpi',  
    '3724574/grammatik_und_rechtschreibprufung_languagetool-3.3.4-fx.xpi'  
  ]  
}

This class install Gimp, Blender, VLC and others useful
graphic tools.

include workstation::multimedia:graphic

This class initialize transmission package. This program is a lightweight,
command-line BitTorrent client with scripting capabilities.

class { 'workstation::multimedia::torrent':  
  destination => 'download/torrent',  
  source => 'download/browser'  
}

This initialize wget package. This computer program that retrieves
content from web servers.

class { 'workstation::multimedia::wget':  
  directory => 'download/wget'  
}

This class initialize youtube-dl package. This program is an
open-source download manager for video and audio from YouTube and
over 1000 other video hosting websites.

class { 'workstation::multimedia::youtube_dl':  
  directory => 'video/youtube'  
}

This class install some programs and change system configurations to
make FreeBSD usable as a desktop station.

include workstation::optimization

This class sets FreeBSD package configurations.

include workstation::package

This class initialize powerd package. This program utility monitors
the system state and sets various power control options accordingly.

include workstation::powerd

This class install most useful hacking tools.

include workstation::programming::hacking

This class initialize LaTeX programming language.

include workstation::programming::latex

This class initialize Common Lisp programming language.

include workstation::programming::lisp::clisp

This class initialize Python programming language.

include workstation::programming::python

This class initialize virtualisation program like Vagrant,
Docker and Virtualbox.

include workstation::programming:virtualisation

This class initialize Apache server.

include workstation::programming::www:apache

This class initialize MySQL database server.

include workstation::programming::www:mysql

This class initialize npm package. This program is a package manager
for the JavaScript programming language.

include workstation::programming::www:npm

This class initialize PHP programming language.

include workstation::programming::www:php

This class install improve the system security.

include workstation::security

This class initialize sudo package. This program is designed to
allow a sysadmin to give limited root privileges to users and log
root activity.

include workstation::sudo

This module manages system configurations.

workstation::system { 'Optimize boot loader':  
  path => '/boot/loader.conf',  
  content => [  
    # Change boot time kernel tuning.  
    'kern.ipc.shmseg = 1024',  
    'kern.ipc.shmmni = 1024',  
    'kern.maxproc = 100000',  

    # Configuring asynchronous I/O.  
    'aio_load = "YES"',  

    # Enable thermal sensors.  
    'coretemp_load="YES"'  
  ]  
}

This class initialize tor, a software for enabling anonymous
communication by directing Internet traffic.

include workstation::tor

This class manages custom directories and xdg-user-dirs, a tool to
help manage well known user directories like the desktop folder and
the music folder.

class { 'workstation::user::directories':  
  download => '/download/browser',  
  directories => [  
    '/download',  
    '/document',  
    '/program',  
    '/video'  
  ]  
}

This class initialize Emacs package. This program is a highly
customizable editor indeed, it has been customized to the point
where it is more like an operating system than an editor!

class { 'workstation::user::emacs':  
  source => 'https://github.com/lognoz/embla'  
}

This class initialize git package. This program is a distributed
version-control system for tracking changes in source code during
software development.

class { 'workstation::user::git':  
  username  => 'Marc-Antoine Loignon',  
  email => '[email protected]'  
  urls => {  
    'https://[email protected]' => 'https://github.com',  
  }  
}

This class initialize Vim package. This program is a highly
configurable text editor built to make creating and changing any
kind of text very efficient.

class { 'workstation::user::vim':  
  source => 'https://github.com/lognoz/vimrc'  
}

This module manages Xorg configurations.

workstation::x11::conf {  
  'xmodmap ~/.Xmodmap':  
}

This module manages Dynamic Windows Manager installation.

include workstation::x11:dwm

This class sets xorg package. Xorg (commonly referred as simply X)
is the most popular display server among Linux and BSD users.

include workstation::x11::xorg

This module is only usable with FreeBSD 13.0.