Home
Softono
macbook-playbook

macbook-playbook

Open source Shell
GitHub
222
Stars
34
Forks
2
Issues
9
Watchers
2 weeks
Last Commit
Infrastructure as Code Package Managers

About macbook-playbook

Install all your applications and configure everything the way you like it with one command

Platforms

Web Self-hosted macOS

Languages

Shell

Links

Source Code
m
Published by
mpereira
Visit View Profile

README.md

View on GitHub

+TITLE: macbook-playbook

+AUTHOR: Murilo Pereira [email protected]

:PROPERTIES: :TOC: ignore :END:

Install all your applications and configure everything the way you like it with one command.

TODO:

  • add brew to path when installing. (/opt/homebrew/bin)
  • add GitHub to known hosts: ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
  • unencrypt and add SSH key to ssh session
  • figure out Emacs symbolic link internal directory
  • make caps lock -> ESC remapping work
  • fix glances webserver "msg: Destination directory /Users/mpereira/Library/LaunchAgents does not exist"
  • install insta360 link ap
  • wait 1s after install spotify and steam
  • GraalVM on apple silicon?
  • kubectl-krew isn't available right after installing
  • launch BTT on startup, load configuration and license
  • symlink id_rsa to mpereira@pluto SSH key
  • turn on dictation

** Table of Contents :PROPERTIES: :TOC: :include all :END: :CONTENTS:

  • [[#table-of-contents][Table of Contents]]
  • [[#tested-on][Tested on]]
  • [[#bootstrap-machine-make-bootstrap][Bootstrap machine (make bootstrap)]]
    • [[#install-developer-tools-xcode-select][Install Developer Tools (xcode-select)]]
    • [[#clone-repository][Clone repository]]
    • [[#give-terminaliterm2emacsetc-assistive-access][Give Terminal/iTerm2/Emacs/etc. assistive access]]
    • [[#secrets][Secrets]]
    • [[#prepare-machine-to-run-the-ansible-playbooks][Prepare machine to run the Ansible playbooks]]
  • [[#configure-machine-make-converge][Configure machine (make converge)]]
    • [[#provision-machine][Provision machine]]
    • [[#manual-steps-post-make-converge][Manual steps post make converge]]
      • [[#change-keyboard-layout-to-us-international][Change keyboard layout to U.S. international]]
      • [[#istat-menus][iStat Menus]]
      • [[#pdf-expert][PDF Expert]]
      • [[#bettertouchtool][BetterTouchTool]]
      • [[#terminal][Terminal]]
        • [[#preferences--profiles--pro--font][Preferences > Profiles > Pro > Font]]
      • [[#system-preferences--security--privacy--privacy--accessibility][System Preferences > Security & Privacy > Privacy >]]
      • [[#system-preferences--keyboard--shortcuts--mission-control][System Preferences > Keyboard > Shortcuts > Mission Control]]
  • [[#roles][Roles]]
    • [[#installs][Installs]]
      • [[#desktop-applications][Desktop Applications]]
      • [[#text-editors][Text Editors]]
      • [[#configuration][Configuration]]
      • [[#programming-languages][Programming Languages]]
      • [[#multimedia][Multimedia]]
      • [[#fonts][Fonts]]
      • [[#browser-plugins][Browser Plugins]]
      • [[#virtualization-provisioning-containers-and-system-tools][Virtualization, Provisioning, Containers and System Tools]]
      • [[#package-managers-and-build-tools][Package Managers and Build Tools]]
      • [[#shell][Shell]]
      • [[#programming-utilities][Programming Utilities]]
      • [[#data-systems][Data Systems]]
      • [[#configuration-monitoring-and-debugging][Configuration, Monitoring and Debugging]]
      • [[#document-processors-and-plotting][Document Processors and Plotting]]
      • [[#markup-tools][Markup Tools]]
      • [[#command-line-tools][Command line tools]]
      • [[#security][Security]]
      • [[#gnu-command-line-tools][GNU Command Line Tools]]
      • [[#miscellaneous][Miscellaneous]]
    • [[#configures][Configures]]
      • [[#makes-google-chrome-the-default-browser][Makes Google Chrome the default browser]]
      • [[#passwordless-sudo][Passwordless sudo]]
      • [[#puts-ssh-keys-in-place][Puts SSH keys in place]]
      • [[#remaps-caps-lock-to-control][Remaps Caps-Lock to Control]]
  • [[#author][Author]]
  • [[#license][License]] :END:

** Tested on I've been using =macbook-playbook= since 2013. I've used it on at least eight MacBook Pros with different macOS versions. As of May 2023 I use it on my personal 16" 2023 Macbook Pro with Ventura installed and on my work 16" 2019 Macbook Pro with Monterey installed.

Please open an issue if you're trying this out and bump into anything.

** Bootstrap machine (=make bootstrap=) These are one-time steps that need to be done on machines that are running =macbook-playbook= for the first time.

*** Install Developer Tools (xcode-select) Open the "Terminal" application, type =git= into the shell and follow the instructions to install the Apple Developer Tools.

*** Clone repository Now your machine should have =git= and =python3= installed.

#+begin_src bash
git clone https://github.com/mpereira/macbook-playbook.git
#+end_src

*** Give Terminal/iTerm2/Emacs/etc. assistive access Depending on your macOS version you will be queried or not for assistive access while =make converge= runs. This is required for example to remap caps lock to control.

In case that task fails, or if you want to do it beforehand just in case, go
to "System Preferences > Security & Privacy > Privacy > [[https://www.howtogeek.com/297083/why-do-some-mac-apps-need-to-control-this-computer-using-accessibility-features/][Accessibility]]" and
add the application running =macbook-playbook= (Terminal/iTerm2/Emacs/etc.)
to the list.

*** Secrets :PROPERTIES: :CUSTOM_ID: secrets :END: I keep secrets encrypted in a file outside of this repository. I have a project (also outside of this repository) that will write all secrets required by this project's roles to =group_vars/localhost/vars.yml=. This file is git-ignored in this project.

These are the roles that use secrets:
| Description                       | Secret name                                | Role              |
| AWS CLI credentials               | =aws_credentials_file_base64=              | awscli            |
| BetterTouchTool license           | =better_touch_tool_license_file_base64=    | better-touch-tool |
| DaisyDisk license                 | =daisydisk_registration_key_file_base64=   | daisydisk         |
| Enviroment variables for [[https://github.com/mpereira/dotfiles][dotfiles]] | =dotfiles_environment_yml_file_base64=     | dotfiles          |
| iStat Menus settings              | =istat_menus_settings_file_base64=         | istat-menus       |
| Prey API key                      | =prey_api_key_yaml_file_base64=            | prey              |
| Private SSH key                   | =mpereira_at_pluto_ssh_private_key_base64= | ssh-keys          |
| s3cmd configuration               | =s3cmd_cfg_file_base64=                    | s3cmd             |

If a =group_vars/localhost/vars.yml= file with those secrets is absent
running these roles will fail.

You have two choices: skip these roles, or write your
=group_vars/localhost/vars.yml=.

To skip them, when you reach the [[#provision-machine][provision machine]] step, make Ansible skip
roles tagged with =uses-secrets=. You don't need to run this now, the
command below is just an example.

#+begin_src bash
make converge ARGS='--skip-tags uses-secrets'
#+end_src

*** Prepare machine to run the Ansible playbooks This will:

  1. Set up passwordless =sudo=
  2. Install a user Python3
  3. Install Ansible
#+begin_src bash
make bootstrap
#+end_src

Your machine should now be ready to be provisioned! You won't need to run
the above steps again.

** Configure machine (=make converge=) Now that the machine is bootstrapped, we can provision it.

*** Provision machine :PROPERTIES: :CUSTOM_ID: provision-machine :END: This runs all non-disabled roles in [[file:main.yml][=main.yml=]].

#+begin_src bash
make converge ARGS='--skip-tags disabled'
#+end_src

~ansible-playbook~ arguments can be passed via the =ARGS= environment variable.
For example, =--tags= can be passed so that only matching roles are run.

#+begin_src bash
make converge ARGS='--tags google-chrome'
#+end_src

=--skip-tags= can also be passed to avoid running certain roles.

#+begin_src bash
make converge ARGS='--skip-tags disabled,unity'
#+end_src

All role tags can be seen in [[file:main.yml][=main.yml=]].

Tasks may fail due to intermittent reasons like temporary server
unavailability. When a task fails you can either disable its role via
=--skip-tags= or use =--start-at-task= with the =name= value of some task to
cause Ansible to start the playbook exactly there.

For example, if the "Install Emacs" task from the "build-emacs" role fails
for what seems to be an intermittent issue, you can pick up provisioning
from there so that previous tasks don't have to re-run.

#+begin_src bash
make converge ARGS='--skip-tags disabled --start-at-task "Install Emacs"'
#+end_src

Check the [[https://docs.ansible.com/ansible/latest/user_guide/playbooks_startnstep.html][official Ansible documentation]] for more details.

*** Manual steps post =make converge= These are steps that are currently not automated because:

  • it would be difficult
  • it would be impossible
  • or I just didn't have the time

**** Change keyboard layout to U.S. international

  1. System Preferences -> Keyboard -> Input Sources
  2. Click +
  3. Select "English" on left column
  4. Select "U.S. International - PC" on right column
  5. Click "Add"
  6. Remove other keyboard layouts from the left column

**** iStat Menus

  1. Import license from =roles/istat-menus/files/iStat Menus Settings.ismp=

**** PDF Expert

  1. Register license

**** BetterTouchTool

  1. Register license

** Terminal *** Preferences > Profiles > Pro > Font Set to =Hack Regular 18 pt=.

**** System Preferences > Security & Privacy > Privacy > [[https://www.howtogeek.com/297083/why-do-some-mac-apps-need-to-control-this-computer-using-accessibility-features/][Accessibility]]

  • BetterTouchTool.app
  • Emacs-*.app
  • MacGPT
  • RescueTime
  • Terminal
  • VLC
  • WhatsApp

**** System Preferences > Keyboard > Shortcuts > Mission Control Uncheck:

  • Mission Control
  • Move left a space
  • Move right a space
  • Switch to desktop 1
 I use these keybindings on Emacs.

** Roles * Installs ** Desktop Applications

**** Text Editors

**** Configuration

 Biome's user-level config is provisioned directly by this playbook at
 =~/Library/Application Support/biome/biome.json=.

 Claude local settings are ignored through =.gitignore=.

**** Programming Languages

**** Multimedia

**** Fonts

**** Browser Plugins

**** Virtualization, Provisioning, Containers and System Tools

**** Package Managers and Build Tools

**** Shell

**** Programming Utilities

**** Data Systems

**** Configuration, Monitoring and Debugging

**** Document Processors and Plotting

**** Markup Tools

**** Command line tools

**** Security

**** GNU Command Line Tools

  • binutils
  • coreutils
  • diffutils
  • ed
  • findutils
  • gawk
  • gnu-indent
  • gnu-sed
  • gnu-tar
  • gnu-which
  • gnutls
  • grep
  • gzip
  • screen
  • watch
  • wdiff
  • wget

**** Miscellaneous

* Configures ** Makes Google Chrome the default browser Passwordless sudo Puts SSH keys in place **** Remaps Caps-Lock to Control Uses an AppleScript helper for the current System Settings flow.

** Author [[http://murilopereira.com][Murilo Pereira]]

** License [[http://opensource.org/licenses/MIT][MIT]]

Local Variables:

before-save-hook: org-make-toc

End: