good-start v1.2.0

Advanced developer setup for macOS and Debian/Ubuntu.

Disclaimer

This is a stable release.

This was tested on Ubuntu 16.04 and macOS 10.13.1 with all roles on.

Quick start

# Setup ansible and other requirements
./ansible-install.sh

# (OPTIONNAL) Make an host_vars directory
mkdir -p host_vars/localhost

# Copy the vars template (see §Configuration for an advanced vars setup)
cp vars.yml.tpl host_vars/localhost/vars.yml

# Edit the vars to match your requirements
vim host_vars/localhost/vars.yml

# (OPTIONNAL) Run in dry-run mode with diff (it will not change anything)
# Note that some parts of the playbook may fail in check mode, while working fine in play mode
ansible-playbook --check --diff playbook.yml

# Run the playbook
ansible-playbook playbook.yml # without ansible-vault
ansible-playbook playbook.yml --ask-vault-pass # with ansible-vault
ansible-playbook playbook.yml --ask-vault-pass --tags "dotfiles,projects" # just for some tags

Requirements

This playbook requires ansible (≥ v2.3.0), aptitude for Debian/Ubuntu or brew and brew-cask for macOS.

You may use ./ansible-install.sh to set everything up or install each package manually.

Configuration

All roles configuration files (clear text or encrypted via ansible-vault) may be stored wherever you want.

As shown in the quick start, you may use the vars.yml.tpl as a basic model. If you want to override the roles variables, look at the variables.md file for a detailed list of all the variables and installed packages/plugins.

You may modify the playbook.yml file to disable some roles or use the --tags arg*.

If you choose to use the host_vars/localhost directory, it may be a good idea to back it up or version it in a secure location if you want to reproduce your setup.

Using ansible-vault to encrypt your sensible infos may be a good idea on a shared computer or if the directory is synced on an insecure drive.

Features

This playbook includes the following roles:

os-setup role

Tags: os-setup

Makes your OS a pleasant environment to work with

• Install binaries and apps (tags: apps)
• Update OS settings to match the user preferences (Only for macOS | tags: settings)
• Customize the Dock content (macOS only | tags: settings)
• Oh-My-Zsh setup (tags: apps,zsh)
• Launchbar configuration updates and actions installation (tags: launchbar)

dotfiles role

Tags: dotfiles

Customizes your apps for a better productivity.

• Dotfiles generation for:
  • Ansible
  • Direnv
  • Git
  • Screen
  • The Silver Searcher
  • Tmux
  • Vim
  • Zsh
  • Aria2
• SSH key generation (only if none found)
• Vim/Neovim packages installation
• Tmux packages installation
• Atom packages installation
• Neovim setup (tags: neovim)
• Iterm2 setup with custom config and theming (macOS only | tags: iterm)
• Terminator setup with custom config (Debian/Ubuntu only | tags: terminator)

docker role

Tags: docker

A fully dockerized workflow is just a step ahead.

• Docker installation (alongside with docker-compose and docker-machine)
• Docker images pull from Docker Hub

projects role

Tags: projects

Your projets are there too!

• Clone the project (with an optionnal custom private ssh key)
• Setup .env file if a declared template exists
• Setup direnv .envrc file with:
  • Custom exports
  • docker-machine support (requires the dotfiles role)
  • docker-compose shortcuts (requires the dotfiles role)

backup role

Tags: backup

Enables automated restic backups on your computer.

• Install restic
• Generate a backup script and an exclusions file
• Initialize a restic repository for $HOME backup
• Schedule the backup with cron

Licence

MIT Licence. Click here to see the full text.

Testing

With the project Vagrantfile, you can test the playbook on Ubuntu Xenial and macOS Sierra. Use vagrant up to launch the two VMs, and ssh into both to test the playbook in the /vagrant mounted directory.

variables.md

To regenerate the variables.md file, use bash doc-generator.sh > variables.md.