This repository contains useful scripts to set up a Unix-y development machine. They have been tested with the following OSes:
Distro | Version(s) | CPU | SKU |
---|---|---|---|
Ubuntu | 18.04, 20.04, 21.10 | Intel (64-bit) | Desktop, WSL 2 |
Pop!_OS | 18.04, 20.04 | Intel (64-bit) | Desktop |
Debian | 10, 11 | Intel (64-bit) | Desktop, WSL 2 |
macOS | 10.15 | Intel (64-bit) | Desktop |
Text shell customization assumes you're using bash (macOS in particular now ships with zsh as the default shell). GUI shell customization assumes you're using Gnome on Linux. Alternate distros and/or shells are left as an exercise for the reader.
The purpose here is to document what I use for my personal Linux-based development. You will likely want to make changes to my customizations, including adding/removing software, choosing different defaults, etc. While you can make those changes locally, if you plan to use these scripts long-term, it will likely be more beneficial for you if you fork this project so you can preserve your changes and easily merge newer versions of these scripts.
Portions copyright (c) Microsoft Corporation, licensed under the MIT license.
-
Install Homebrew
-
Change the default shell from zsh to bash:
$ chsh -s /bin/bash $ echo "export BASH_SILENCE_DEPRECATION_WARNING=1" >> ~/.bashrc $ chmod 700 ~/.bashrc $ ln -s ~/.bashrc ~/.bash_profile
-
Set up Python 3 as the default version of Python:
$ echo "alias python='python3'" >> ~/.bashrc $ echo "export PATH=$HOME/Library/Python/3.7/bin:$PATH" >> ~/.bashrc
-
Install Ansible
-
Make sure you're up to date:
$ sudo apt update $ sudo apt -y upgrade
-
Install Ansible:
$ sudo apt -y install ansible
-
If you want to clone this Git repo, you should also install Git (
sudo apt -y install git
). These scripts will install it for you if you brought these files along in some other way.
Before running the scripts, please review _all.yaml
and _all_no_customization.yaml
, and comment out software you don't want installed. In particular, most folders contain customization.yaml
files which tend to contain my personal opinions on customizations; feel free to comment out sections of those files, or ignore them entirely.
To run the setup:
$ ansible-playbook -K _all.yaml
You will be prompted for your password, so that administrative-level software can be installed. You must be a sudoer to run these scripts, otherwise the installation process will fail. You can also run individual files if you'd prefer to take more control over what's executed.
Since core OS packages are upgraded, it is safest to reboot the PC/VM after running these scripts. At a bare minimum, many UI shell customizations done here will require you to log out and log back in.
In general, these scripts are optimized around the experience of users of Ubuntu desktop distributions. These scripts install GUI-based applications, and manipulate the GUI shell for development purposes. They will probably most work on a server-based distribution if that's what you use for development, though they will require significant reworking.
Special affordances are made to enable support for WSL 2. Most of the GUI customization is not done, though some GUI applications are installed. Users will need to use Windows 11 (for WSLg) or install an X server on their machine to run those GUI applications. Instructions for enabling WSLg are available on the WSLg GitHub project README.
- Insync is not yet available on Debian Bullseye.
Most software does work on macOS, with a few exceptions noted below:
- Insync is replaced with the native Google Backup and Sync
- QEMU/KVM is replaced with VirtualBox (note that installing VirtualBox might fail the first time because of required permissions)
- Remmina is not available, and Microsoft Remote Desktop Client must be installed from the App Store
- Gnome-specific tweaks and applications are not supported
If you're noticing that Docker isn't running:
$ sudo service docker start
* Starting Docker: docker
$ docker ps
Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
Check the Docker logs with tail /var/log/docker.log
. If you see a line like this:
failed to start daemon: Error initializing network controller: error obtaining controller instance: unable to add return rule in DOCKER-ISOLATION-STAGE-1 chain: (iptables failed: iptables --wait -A DOCKER-ISOLATION-STAGE-1 -j RETURN: iptables v1.8.7 (nf_tables): RULE_APPEND failed (No such file or directory): rule in chain DOCKER-ISOLATION-STAGE-1 (exit status 4))
That means you need to enable iptables-legacy
for Docker networking to function properly (your distro is likely using something else, like iptables-nft
as indicated in the error message above). I've noticed this the most with Debian 10+ and Ubuntu 21.10+. Run these command:
$ sudo update-alternatives --set iptables /usr/sbin/iptables-legacy
update-alternatives: using /usr/sbin/iptables-legacy to provide /usr/sbin/iptables (iptables) in manual mode
$ sudo service docker start
* Starting Docker: docker
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
It is strongly recommended that you reboot after making this change, so that it filters throughout the entire networking stack.