Compare commits

...

68 Commits

Author SHA1 Message Date
Brooke Kuhlmann
aa72537f4f Added version release notes 2021-12-27 07:41:45 -07:00
Brooke Kuhlmann
446f33dd30 Updated to Ruby 3.1.0
[Details](https://www.ruby-lang.org).
2021-12-25 08:36:36 -07:00
Brooke Kuhlmann
68583f3dc0 Fixed Rubocop Bundler/OrderedGems issue 2021-12-24 11:44:08 -07:00
Brooke Kuhlmann
c7dc1abd24 Added README troubleshooting guide for SMC reset
This can, sometimes, be good for speeding up system performance.
2021-12-03 08:48:21 -07:00
Brooke Kuhlmann
4832f857a5 Updated GitHub issue template
Provides a minor reduction in steps necessary to file an issue by
capturing the important details in the overview so the rest of the
issue can focus on the details.
2021-11-24 09:05:37 -07:00
Brooke Kuhlmann
91075b7001 Updated to Ruby 3.0.3
Necessary to resolve several security vulnerabilities.

[Details](https://www.ruby-lang.org).
2021-11-24 08:23:19 -07:00
Brooke Kuhlmann
c7099baa63 Fixed Hippocratic license structure
Turns out the generated version of the license has a lot of bugs in it
in terms of formatting (especially the original Markdown version) and
code comments. This attempts to clean up the syntax so the document is
more readable.
2021-11-22 12:46:36 -07:00
Brooke Kuhlmann
860accf53f Fixed contributing documentation
Necessary to clarify and streamline the required steps. Most
importantly the `master` branch is no longer referenced since the
`main` branch is the default now.
2021-11-22 11:08:24 -07:00
Brooke Kuhlmann
f4292a0e7d Added project citation information
Necessary allow academics and researchers to reference this project.

[Documentation](https://citation-file-format.github.io).
2021-11-21 14:26:49 -07:00
Brooke Kuhlmann
49be191b7b Updated to Hippocratic License 3.0.0
Necessary to promote ethicial software engineering practices but also
align with the Alchemists' mission.

[Details](https://firstdonoharm.dev).
2021-11-21 12:23:33 -07:00
Brooke Kuhlmann
644ad6388b Fixed README changes and credits sections
Necessary to clarify the information housed in these sections.
2021-11-20 16:04:00 -07:00
Brooke Kuhlmann
892b8119c9 Added README community link
Necessary to provide a way for people to interact and discuss this
project more in depth if desired.
2021-11-04 20:35:17 -06:00
Brooke Kuhlmann
0cd587c527 Added version release notes 2021-10-25 18:02:18 -06:00
Brooke Kuhlmann
bfaba4b40d Updated to macOS Monterey
Necessary to support the latest version of the operation system which
was released today.
2021-10-25 18:00:45 -06:00
Brooke Kuhlmann
0445e6a584 Removed notes from pull request template
Unnecessary since footnotes can be used instead and further simplifies
the information needed from contributors.
2021-10-20 19:17:50 -06:00
Brooke Kuhlmann
740c91103a Added version release notes 2021-08-01 08:46:48 -06:00
Brooke Kuhlmann
80f289a6b8 Removed NPM install check function
No longer necessary now that Fast Node Manager is being used and
replaces this functionality.
2021-07-29 19:59:42 -06:00
Brooke Kuhlmann
e919d07068 Added install Node function
Necessary to ensure Node is installed using the latest stable release
by default.
2021-07-29 19:58:51 -06:00
Brooke Kuhlmann
2e95c72d57 Updated Node package install script to use NPM
Yarn has fallen out of favor in the community so have switched to
native NPM support instead.
2021-07-29 18:00:04 -06:00
Brooke Kuhlmann
f790b05831 Updated shell option help text
Necessary to help clarify the install option.
2021-07-25 08:42:33 -06:00
Brooke Kuhlmann
c849ac76e2 Updated Ruby installer to use Frum
Necessary to match upcoming changes in the macOS Configuration project
where Frum is now the default Ruby Version Manager instead of chruby.
2021-07-25 08:26:21 -06:00
Brooke Kuhlmann
029fce45b4 Added version release notes 2021-07-17 11:44:05 -06:00
Brooke Kuhlmann
e9d1928b90 Updated to Ruby 3.0.2
Necessary to address security fixes. [Details](https://chl.li/J2u5O).
2021-07-07 13:29:28 -06:00
Brooke Kuhlmann
14394e5c51 Updated to Ruby 3.0.1
Necessary to account for a couple of security vulnerabilities with temp
path and the REXML library.
2021-04-05 17:58:32 -06:00
Brooke Kuhlmann
566b9d871e Added version release notes 2021-03-16 18:22:22 -06:00
Brooke Kuhlmann
f640e37089 Updated setup software as configure software script
Necessary to better describe the purpose of this script.
2021-03-16 18:21:28 -06:00
Brooke Kuhlmann
c3c3036c88 Added dotfiles script
Necessary to make installing personal dotfiles a first class citizen
like many of the other install scripts. Having one's own dotfiles as
part of the machine setup helps ensure the shell is configured properly
especially when it comes to dealing with language specific dependencies
for Ruby, Rust, Node, etc. This reduces duplication within this project
-- and the macOS Configuration project -- from having to know all of
these details when settings can be defined within one's own dotfiles
once.
2021-03-16 18:21:18 -06:00
Brooke Kuhlmann
6990b9d2c6 Added Node packages script
Necessary to provide a single source of truth for installing Node
dependencies. This used to be managed by the Yarn Setup project but
that project is being deprecated in favor of this project.
2021-03-16 18:21:09 -06:00
Brooke Kuhlmann
b8d96b3479 Fixed environment configuration to source Bash resource
Once the `.bashrc` file has been created, immediately load it so
contents are executed instead of duplicating this work on a separate
line.
2021-03-16 18:21:06 -06:00
Brooke Kuhlmann
be9edafe52 Added Ruby gems script
Necessary to provide a single source of truth for installing Ruby
dependencies. This used to be managed by the Ruby Setup project but
that project is being deprecated in favor of this project.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
c62ef77ce2 Updated install root detection to support Elm
Necessary so Elm can be installed properly since Homebrew support isn't
great.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
e9cd22bb36 Added bare package installer
Necessary to download and install bare packages that are not wrapped as
DMGs or zips first.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
e9476d6a6a Refactored install scripts to separate script paths
Minor improvement to readability so the script path stands out as being
configuragble versus being grouped with the default Bash settings.
2021-03-16 18:20:57 -06:00
Brooke Kuhlmann
35663cf8b3 Added Rust crates script
Necessary to implement the installation of Rust and associated crates
which can be used by downstream configurations. This functionality was
originally part of the macOS Configuration project but has been moved
here to provide a common foundation in which to build upon.
2021-03-16 18:20:44 -06:00
Brooke Kuhlmann
eec175e232 Added mas check to App Store install script
Necessary to ensure mas is installed before executing the script. This
reduces the strain on downstream projects/scripts from having to do
this check. This was previously part of the macOS Configuration project
but has been moved here as central location for core functionality.
2021-03-14 11:24:12 -06:00
Brooke Kuhlmann
dd62dad160 Added Homebrew installation to Homebrew sripts
Ensures Homebrew is installed before running scripts so downstream
projects don't have to remember to do this work.
2021-03-14 11:11:11 -06:00
Brooke Kuhlmann
c65f06d5b8 Removed CPU detection in favor of architecture detection
Provides a cleaner and more reliable way to determine what machine
architecture is being used.
2021-02-28 09:10:42 -07:00
Brooke Kuhlmann
6567969919 Updated dev tools installer to agree to Rosetta license
Necessary to reduce an additional prompt for the user to deal with and
allow a more automated install process. This also includes better
architecture detection, instead of CPU detection, when determining
whether to install Rosetta.
2021-02-28 09:09:27 -07:00
Brooke Kuhlmann
82d50299c7 Added version release notes 2021-02-27 15:36:46 -07:00
Brooke Kuhlmann
ec441aefef Added environment configuration for scripts
Necessary to ensure machines are properly configured for running these
scripts on either Apple Silicon or Intel based machines.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
e4ef33a5f6 Added Rosetta to development tools install script
Necessary for Apple Silicon machines -- at least for the time being --
in order to translate Intel based programs that are not ready to run
natively of Silicon hardware yet.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
eaefe9fa04 Added Homebrew install function
Necessary to define the installation of Homebrew via a single function.
This was originally part of the macOS Configuration project but is now
located here instead.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
71da0e7b1b Added Homebrew utility path functions
Necessary to compute the correct Homebrew paths for both Silicon and
Intel based machines.
2021-02-27 11:24:57 -07:00
Brooke Kuhlmann
2c518d797e Added CPU utility function
Necessary for answering CPU of current machine when determining what
kind of functionality should be used when executing scripts on Silicon
or Intel based hardware. In this case, it'll answers "M1" when using an
Apple Silicon chip. For Intel based machines, nothing will be answered
since they use multiple "Processor" fields.
2021-02-22 20:10:12 -07:00
Brooke Kuhlmann
5e25c8d3f9 Refactored utility functions to be alphabetically sorted
Speeds up function lookup within the source code.
2021-02-21 12:57:50 -07:00
Brooke Kuhlmann
3aea499672 Refactored verifier functions to be alphabetically sorted
Speeds up function lookup within the source code.
2021-02-21 12:56:21 -07:00
Brooke Kuhlmann
0ddd9b0986 Refactored installer functions to be alphabetically sorted
Speeds up lookup for each function.
2021-02-21 12:52:49 -07:00
Brooke Kuhlmann
5a4d45ffed Added Apple Silicon instructions
Necessary to support the new Apple Silicon (M1) chips and older
Intel-based systems.
2021-02-20 09:43:01 -07:00
Brooke Kuhlmann
cb3ed0108d Updated to Docker Alpine Ruby image
Provides a smaller footprint for testing Ruby code.
2021-02-13 09:53:02 -07:00
Brooke Kuhlmann
8c4c734043 Updated to Circle CI 2.1.0
Necessary to pick up the new syntax, configuration location, and custom
Docker image.
2021-01-23 17:50:00 -07:00
Brooke Kuhlmann
160447eda3 Added version release notes 2021-01-10 10:42:35 -07:00
Brooke Kuhlmann
803c38e1c2 Updated boot disk recovery documentation
Improves labeling and categorization consistency while also cleaning up
some of the README terminology.

The recovery option is more of a last resort, provided by Apple, should
something catastrophic happen with the boot disk.
2021-01-10 10:36:09 -07:00
Brooke Kuhlmann
76432f5a74 Fixed brew formulae list error
Resolves the following from happening:

    Error: Calling `brew list` to only list formulae is disabled! Use
    `brew list --formula` instead.

Includes a correction for the plural form for `casks` as well.
2021-01-04 19:31:40 -07:00
Brooke Kuhlmann
85c85a5e80 Added version release notes 2021-01-03 16:49:15 -07:00
Brooke Kuhlmann
b83ecf6516 Removed README Startup Security Utility documentation
Added to the macOS Configuration project, instead, since it makes more
sense to keep all pre and post install steps together in one place.
2021-01-03 14:41:57 -07:00
Brooke Kuhlmann
3889930672 Added caffeination to restore process
Restoration from backup can take a while so this ensures the machine
doesn't go to sleep during this process.
2021-01-03 14:41:16 -07:00
Brooke Kuhlmann
856f51422a Updated troubleshooting documentation
Focuses on issues experienced related to the macOS Big Sur upgrade.
2021-01-03 14:31:16 -07:00
Brooke Kuhlmann
433ad04028 Updated boot disk instructions for main disk format
Necessary because installation of Big Sur doesn't seem to like password
protected APFS drives. Disk encryption will have to happen after
installation via FileVault.
2021-01-03 14:31:15 -07:00
Brooke Kuhlmann
605190577f Added version release notes 2020-12-30 10:31:46 -07:00
Brooke Kuhlmann
c9c7f46e4a Updated to Git Lint 2.0.0
Supports Ruby 3.0.0.

[Details](https://www.alchemists.io/projects/git-lint/changes.html).
2020-12-29 19:33:36 -07:00
Brooke Kuhlmann
f8a779e926 Updated to Ruby 3.0.0
Includes temporary disablement of gem dependencies that require
updating to Ruby 3.0.0 first.

[Details](https://chl.li/LdWrE).
2020-12-29 10:35:38 -07:00
Brooke Kuhlmann
e6f991baca Added Circle CI explicit Bundle install configuration
Due to fixing the `vendor/bundle` path earlier (see previous commit),
we need to be explicit with the installation of gems now.
2020-12-20 07:15:38 -07:00
Brooke Kuhlmann
ae6ab46fa7 Fixed Circle CI configuration for Bundler config path
Prevents the following deprecation warning:

    [DEPRECATED] The `--path` flag is deprecated because it relies on
    being remembered across bundler invocations, which bundler will no
    longer do in future versions. Instead please use `bundle config set
    path 'vendor/bundle'`, and stop using this flag.
2020-12-19 17:10:44 -07:00
Brooke Kuhlmann
45a6c5d1b0 Added version release notes 2020-11-15 07:38:09 -07:00
Brooke Kuhlmann
1bb6ef39a5 Added macOS Big Sur support
Necessary to support the latest macOS release.
2020-11-15 07:35:58 -07:00
Brooke Kuhlmann
1416aa2f0a Updated to Git Lint 1.3.0
[Changes](https://www.alchemists.io/projects/git-lint/changes.html).
2020-11-14 17:37:33 -07:00
Brooke Kuhlmann
b6cddae599 Updated project documentation to conform to Rubysmith template
Necessary to match consistency used by the
[Rubysmith](https://www.alchemists.io/projects/rubysmith) when
building/maintaining projects.
2020-10-13 20:07:16 -06:00
Brooke Kuhlmann
e533bf04be Updated to Ruby 2.7.2
Fixes a WEBrick security flaw but also disables deprecation warnings by
default which is sad to see. We'll have to enable these ourselves if we
want to have an early warning sign of future breaking changes. 😢

[Release Notes](https://chl.li/lLaOn)
2020-10-03 08:27:07 -06:00
34 changed files with 956 additions and 560 deletions

31
.circleci/config.yml Normal file
View File

@@ -0,0 +1,31 @@
version: 2.1
jobs:
build:
working_directory: ~/project
docker:
- image: bkuhlmann/alpine-ruby:latest
steps:
- checkout
- restore_cache:
name: Bundler Restore
keys:
- gem-cache-{{.Branch}}-{{checksum "Gemfile"}}
- gem-cache-
- run:
name: Bundler Install
command: |
gem update --system
bundle config set path "vendor/bundle"
bundle install
- save_cache:
name: Bundler Store
key: gem-cache-{{.Branch}}-{{checksum "Gemfile"}}
paths:
- vendor/bundle
- run:
name: Build
command: bundle exec rake

View File

@@ -1,5 +1,5 @@
## Overview
<!-- Required. Describe, briefly, the behavior experienced. -->
<!-- Required. Describe, briefly, the behavior experienced and desired. -->
## Screenshots/Screencasts
<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
@@ -7,8 +7,5 @@
## Steps to Recreate
<!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
## Desired Behavior
<!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
## Environment
<!-- Required. What is your operating system, software version(s), etc. -->

View File

@@ -6,6 +6,3 @@
## Details
<!-- Optional. List the key features/highlights as bullet points. -->
## Notes
<!-- Optional. List additional notes/references as bullet points. -->

View File

@@ -1 +1 @@
2.7.1
3.1.0

View File

@@ -1,5 +1,94 @@
= Changes
== 15.0.0 (2021-12-27)
* Fixed Hippocratic license structure - Brooke Kuhlmann
* Fixed README changes and credits sections - Brooke Kuhlmann
* Fixed Rubocop Bundler/OrderedGems issue - Brooke Kuhlmann
* Fixed contributing documentation - Brooke Kuhlmann
* Added README community link - Brooke Kuhlmann
* Added README troubleshooting guide for SMC reset - Brooke Kuhlmann
* Added project citation information - Brooke Kuhlmann
* Updated GitHub issue template - Brooke Kuhlmann
* Updated to Hippocratic License 3.0.0 - Brooke Kuhlmann
* Updated to Ruby 3.0.3 - Brooke Kuhlmann
* Updated to Ruby 3.1.0 - Brooke Kuhlmann
== 14.0.0 (2021-10-25)
* Updated to macOS Monterey - Brooke Kuhlmann
* Removed notes from pull request template - Brooke Kuhlmann
== 13.0.0 (2021-08-01)
* Added install Node function - Brooke Kuhlmann
* Updated Node package install script to use NPM - Brooke Kuhlmann
* Updated Ruby installer to use Frum - Brooke Kuhlmann
* Updated shell option help text - Brooke Kuhlmann
* Removed NPM install check function - Brooke Kuhlmann
== 12.0.1 (2021-07-17)
* Updated to Ruby 3.0.1 - Brooke Kuhlmann
* Updated to Ruby 3.0.2 - Brooke Kuhlmann
== 12.0.0 (2021-03-16)
* Fixed environment configuration to source Bash resource - Brooke Kuhlmann
* Added Homebrew installation to Homebrew sripts - Brooke Kuhlmann
* Added Node packages script - Brooke Kuhlmann
* Added Ruby gems script - Brooke Kuhlmann
* Added Rust crates script - Brooke Kuhlmann
* Added bare package installer - Brooke Kuhlmann
* Added dotfiles script - Brooke Kuhlmann
* Added mas check to App Store install script - Brooke Kuhlmann
* Added version release notes - Brooke Kuhlmann
* Updated dev tools installer to agree to Rosetta license - Brooke Kuhlmann
* Updated install root detection to support Elm - Brooke Kuhlmann
* Updated setup software as configure software script - Brooke Kuhlmann
* Removed CPU detection in favor of architecture detection - Brooke Kuhlmann
* Refactored install scripts to separate script paths - Brooke Kuhlmann
== 11.2.0 (2021-02-27)
* Added Apple Silicon instructions - Brooke Kuhlmann
* Added CPU utility function - Brooke Kuhlmann
* Added Homebrew install function - Brooke Kuhlmann
* Added Homebrew utility path functions - Brooke Kuhlmann
* Added Rosetta to development tools install script - Brooke Kuhlmann
* Added environment configuration for scripts - Brooke Kuhlmann
* Updated to Circle CI 2.1.0 - Brooke Kuhlmann
* Updated to Docker Alpine Ruby image - Brooke Kuhlmann
* Refactored installer functions to be alphabetically sorted - Brooke Kuhlmann
* Refactored utility functions to be alphabetically sorted - Brooke Kuhlmann
* Refactored verifier functions to be alphabetically sorted - Brooke Kuhlmann
== 11.1.1 (2021-01-10)
* Fixed brew formulae list error - Brooke Kuhlmann
* Updated boot disk recovery documentation - Brooke Kuhlmann
== 11.1.0 (2021-01-03)
* Added caffeination to restore process - Brooke Kuhlmann
* Updated boot disk instructions for main disk format - Brooke Kuhlmann
* Updated troubleshooting documentation - Brooke Kuhlmann
* Removed README Startup Security Utility documentation - Brooke Kuhlmann
== 11.0.0 (2020-12-30)
* Fixed Circle CI configuration for Bundler config path - Brooke Kuhlmann
* Added Circle CI explicit Bundle install configuration - Brooke Kuhlmann
* Updated to Git Lint 2.0.0 - Brooke Kuhlmann
* Updated to Ruby 3.0.0 - Brooke Kuhlmann
== 10.0.0 (2020-11-15)
* Added macOS Big Sur support
* Updated project documentation to conform to Rubysmith template
* Updated to Git Lint 1.3.0
* Updated to Ruby 2.7.2
== 9.0.0 (2020-09-12)
* Fixed Homebrew cask verifier deprecation warning

21
CITATION.cff Normal file
View File

@@ -0,0 +1,21 @@
cff-version: 1.2.0
message: Please use the following metadata when citing this project in your work.
title: macOS
abstract: Provides a shell based framework for automating the setup of a macOS machine.
version: 15.0.0
license: Hippocratic-3.0
date-released: 2021-12-27
authors:
- family-names: Kuhlmann
given-names: Brooke
affiliation: Alchemists
orcid: https://orcid.org/0000-0002-5810-6268
keywords:
- bash
- shell
- scripts
- automation
- setup
- recovery
repository-code: https://www.alchemists.io/projects/mac_os
repository-artifact: https://www.alchemists.io/projects/mac_os

View File

@@ -51,7 +51,8 @@ an appointed representative at an online or offline event.
== Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Alchemists].
leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Brooke Kuhlmann].
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any
@@ -102,7 +103,7 @@ disparagement of classes of individuals.
This Code of Conduct is adapted from the
link:https://www.contributor-covenant.org/version/2/0/code_of_conduct.html[Contributor Covenant,
version 2.0].
Version 2.0].
Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's
code of conduct enforcement ladder].

View File

@@ -1,12 +1,12 @@
= Contributing
Thanks for taking an interest in this open source project. Your support and involvement is greatly
appreciated. The following details what you need to know in order to contribute.
Thanks for taking an interest in this open source project. Your involvement and support is greatly
appreciated. The following details what you must know to contribute.
== Code
. Read the project link:README.adoc[README] before starting.
. Fork and clone the `master` branch of this repository locally.
. Fork, clone, and create a feature branch this repository for local development.
. Ensure there are no setup, usage, and/or test issues.
. Add tests for new functionality and ensure they pass.
. Submit a pull request, follow the instructions provided, and ensure the build passes.

View File

@@ -2,5 +2,5 @@
source "https://rubygems.org"
gem "git-lint", "~> 2.0"
gem "rake", "~> 13.0"
gem "git-lint", "~> 1.0"

View File

@@ -1,162 +1,214 @@
= Apache License
= HIPPOCRATIC LICENSE
Version 2.0, January 2004
*Version 3.0, October 2021*
http://www.apache.org/licenses
https://firstdonoharm.dev
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*TERMS AND CONDITIONS*
== 1. Definitions
TERMS AND CONDITIONS FOR USE, COPY, MODIFICATION, PREPARATION OF DERIVATIVE WORK, REPRODUCTION, AND DISTRIBUTION:
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
Sections 1 through 9 of this document.
== 1. DEFINITIONS
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
granting the License.
_This section defines certain terms used throughout this license agreement._
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are
controlled by, or are under common control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the direction or management of such
entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
1.1. "License" means the terms and conditions, as stated herein, for use, copy, modification, preparation of derivative work, reproduction, and distribution of Software (as defined below).
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this
License.
1.2. "Licensor" means the copyright and/or patent owner or entity authorized by the copyright and/or patent owner that is granting the License.
"Source" form shall mean the preferred form for making modifications, including but not limited to
software source code, documentation source, and configuration files.
1.3. "Licensee" means the individual or entity exercising permissions granted by this License, including the use, copy, modification, preparation of derivative work, reproduction, and distribution of Software (as defined below).
"Object" form shall mean any form resulting from mechanical transformation or translation of a
Source form, including but not limited to compiled object code, generated documentation, and
conversions to other media types.
1.4. "Software" means any copyrighted work, including but not limited to software code, authored by Licensor and made available under this License.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the
License, as indicated by a copyright notice that is included in or attached to the work (an example
is provided in the Appendix below).
1.5. "Supply Chain" means the sequence of processes involved in the production and/or distribution of a commodity, good, or service offered by the Licensee.
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
derived from) the Work and for which the editorial revisions, annotations, elaborations, or other
modifications represent, as a whole, an original work of authorship. For the purposes of this
License, Derivative Works shall not include works that remain separable from, or merely link (or
bind by name) to the interfaces of, the Work and Derivative Works thereof.
1.6. "Supply Chain Impacted Party" or "Supply Chain Impacted Parties" means any person(s) directly impacted by any of Licensees Supply Chain, including the practices of all persons or entities within the Supply Chain prior to a good or service reaching the Licensee.
"Contribution" shall mean any work of authorship, including the original version of the Work and any
modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted
to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity
authorized to submit on behalf of the copyright owner. For the purposes of this definition,
"submitted" means any form of electronic, verbal, or written communication sent to the Licensor or
its representatives, including but not limited to communication on electronic mailing lists, source
code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor
for the purpose of discussing and improving the Work, but excluding communication that is
conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
Contribution."
1.7. "Duty of Care" is defined by its use in tort law, delict law, and/or similar bodies of law closely related to tort and/or delict law, including without limitation, a requirement to act with the watchfulness, attention, caution, and prudence that a reasonable person in the same or similar circumstances would use towards any Supply Chain Impacted Party.
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
Contribution has been received by Licensor and subsequently incorporated within the Work.
1.8. "Worker" is defined to include any and all permanent, temporary, and agency workers, as well as piece-rate, salaried, hourly paid, legal young (minors), part-time, night, and migrant workers.
== 2. Grant of Copyright License
== 2. INTELLECTUAL PROPERTY GRANTS
Subject to the terms and conditions of this License, each Contributor hereby grants to You a
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
distribute the Work and such Derivative Works in Source or Object form.
_This section identifies intellectual property rights granted to a Licensee_.
== 3. Grant of Patent License
2.1. _Grant of Copyright License_: Subject to the terms and conditions of this License, Licensor hereby grants to Licensee a worldwide, non-exclusive, no-charge, royalty-free copyright license to use, copy, modify, prepare derivative work, reproduce, or distribute the Software, Licensor authored modified software, or other work derived from the Software.
Subject to the terms and conditions of this License, each Contributor hereby grants to You a
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer
the Work, where such license applies only to those patent claims licensable by such Contributor that
are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You institute patent litigation
against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or
a Contribution incorporated within the Work constitutes direct or contributory patent infringement,
then any patent licenses granted to You under this License for that Work shall terminate as of the
date such litigation is filed.
2.2 _Grant of Patent License_: Subject to the terms and conditions of this License, Licensor hereby grants Licensee a worldwide, non-exclusive, no-charge, royalty-free patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer Software.
== 4. Redistribution
== 3. ETHICAL STANDARDS
You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
or without modifications, and in Source or Object form, provided that You meet the following
conditions:
_This section lists conditions the Licensee must comply with in order to have rights under this License._
. You must give any other recipients of the Work or Derivative Works a copy of this License; and
The rights granted to the Licensee by this License are expressly made subject to the Licensees ongoing compliance with the following conditions:
. You must cause any modified files to carry prominent notices stating that You changed the files;
and
3.1. The Licensee SHALL NOT, whether directly or indirectly, through agents or assigns:
. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
patent, trademark, and attribution notices from the Source form of the Work, excluding those
notices that do not pertain to any part of the Derivative Works; and
3.1.1. Infringe upon any persons right to life or security of person, engage in extrajudicial killings, or commit murder, without lawful cause +
(See Article 3, _United Nations Universal Declaration of Human Rights_; Article 6, _International Covenant on Civil and Political Rights_)
. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
that You distribute must include a readable copy of the attribution notices contained within such
NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
at least one of the following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along with the Derivative
Works; or, within a display generated by the Derivative Works, if and wherever such third-party
notices normally appear. The contents of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution notices within Derivative Works that
You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
additional attribution notices cannot be construed as modifying the License.
3.1.2. Hold any person in slavery, servitude, or forced labor +
(See Article 4, _United Nations Universal Declaration of Human Rights_; Article 8, _International Covenant on Civil and Political Rights_);
You may add Your own copyright statement to Your modifications and may provide additional or
different license terms and conditions for use, reproduction, or distribution of Your modifications,
or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
the Work otherwise complies with the conditions stated in this License.
3.1.3. Contribute to the institution of slavery, slave trading, forced labor, or unlawful child labor +
(See Article 4, _United Nations Universal Declaration of Human Rights_; Article 8, _International Covenant on Civil and Political Rights_);
== 5. Submission of Contributions
3.1.4. Torture or subject any person to cruel, inhumane, or degrading treatment or punishment +
(See Article 5, _United Nations Universal Declaration of Human Rights_; Article 7, _International Covenant on Civil and Political Rights_);
Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
Work by You to the Licensor shall be under the terms and conditions of this License, without any
additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed with Licensor regarding such
Contributions.
3.1.5. Discriminate on the basis of sex, gender, sexual orientation, race, ethnicity, nationality, religion, caste, age, medical disability or impairment, and/or any other like circumstances +
(See Article 7, _United Nations Universal Declaration of Human Rights_; Article 2, _International Covenant on Economic, Social and Cultural Rights_; Article 26, _International Covenant on Civil and Political Rights_);
== 6. Trademarks
3.1.6. Prevent any person from exercising his/her/their right to seek an effective remedy by a competent court or national tribunal (including domestic judicial systems, international courts, arbitration bodies, and other adjudicating bodies) for actions violating the fundamental rights granted to him/her/them by applicable constitutions, applicable laws, or by this License +
(See Article 8, _United Nations Universal Declaration of Human Rights_; Articles 9 and 14, _International Covenant on Civil and Political Rights_);
This License does not grant permission to use the trade names, trademarks, service marks, or product
names of the Licensor, except as required for reasonable and customary use in describing the origin
of the Work and reproducing the content of the NOTICE file.
3.1.7. Subject any person to arbitrary arrest, detention, or exile +
(See Article 9, _United Nations Universal Declaration of Human Rights_; Article 9, _International Covenant on Civil and Political Rights_);
== 7. Disclaimer of Warranty
3.1.8. Subject any person to arbitrary interference with a persons privacy, family, home, or correspondence without the express written consent of the person +
(See Article 12, _United Nations Universal Declaration of Human Rights_; Article 17, _International Covenant on Civil and Political Rights_);
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied, including, without limitation, any warranties or conditions of
TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
responsible for determining the appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
3.1.9. Arbitrarily deprive any person of his/her/their property +
(See Article 17, _United Nations Universal Declaration of Human Rights_);
== 8. Limitation of Liability
3.1.10. Forcibly remove indigenous peoples from their lands or territories or take any action with the aim or effect of dispossessing indigenous peoples from their lands, territories, or resources, including without limitation the intellectual property or traditional knowledge of indigenous peoples, without the free, prior, and informed consent of indigenous peoples concerned +
(See Articles 8 and 10, _United Nations Declaration on the Rights of Indigenous Peoples_);
In no event and under no legal theory, whether in tort (including negligence), contract, or
otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
agreed to in writing, shall any Contributor be liable to You for damages, including any direct,
indirect, special, incidental, or consequential damages of any character arising as a result of this
License or out of the use or inability to use the Work (including but not limited to damages for
loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
damages or losses), even if such Contributor has been advised of the possibility of such damages.
3.1.11. Be an individual or entity, or a representative, agent, affiliate, successor, attorney, or assign of an individual or entity, on the FFI Solutions Carbon Underground 200 list;
== 9. Accepting Warranty or Additional Liability
3.1.12. Commit ecocide:
While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
consistent with this License. However, in accepting such obligations, You may act only on Your own
behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or
claims asserted against, such Contributor by reason of your accepting any such warranty or
additional liability.
3.1.12.1 For the purpose of this section, "ecocide" means unlawful or wanton acts committed with knowledge that there is a substantial likelihood of severe and either widespread or long-term damage to the environment being caused by those acts;
END OF TERMS AND CONDITIONS
3.1.12.2 For the purpose of further defining ecocide and the terms contained in the previous paragraph:
Copyright link:https://www.alchemists.io[Alchemists].
3.1.12.2.1. "Wanton" means with reckless disregard for damage which would be clearly excessive in relation to the social and economic benefits anticipated;
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
of the License.
3.1.12.2.2. "Severe" means damage which involves very serious adverse changes, disruption, or harm to any element of the environment, including grave impacts on human life or natural, cultural, or economic resources;
Unless required by applicable law or agreed to in writing, software distributed under the License is
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing permissions and limitations under the
License.
3.1.12.2.3. "Widespread" means damage which extends beyond a limited geographic area, crosses state boundaries, or is suffered by an entire ecosystem or species or a large number of human beings;
3.1.12.2.4. "Long-term" means damage which is irreversible or which cannot be redressed through natural recovery within a reasonable period of time; and
3.1.12.2.5. "Environment" means the earth, its biosphere, cryosphere, lithosphere, hydrosphere, and atmosphere, as well as outer space
(See Section II, _Independent Expert Panel for the Legal Definition of Ecocide_, Stop Ecocide Foundation and the Promise Institute for Human Rights at UCLA School of Law, June 2021);
3.1.13. Be an individual or entity, or a representative, agent, affiliate, successor, attorney, or assign of an individual or entity, that engages in fossil fuel or mineral exploration, extraction, development, or sale;
3.1.14. Be an individual or entity, or a representative, agent, affiliate, successor, attorney, or assign of an individual or entity, identified by the Boycott, Divestment, Sanctions ("BDS") movement on its website (https://bdsmovement.net/ and https://bdsmovement.net/get-involved/what-to-boycott) as a target for boycott;
3.1.15. Be an individual or entity that:
3.1.15.1. engages in any commercial transactions with the Taliban; or
3.1.15.2. is a representative, agent, affiliate, successor, attorney, or assign of the Taliban;
3.1.16. Be an individual or entity that:
3.1.16.1. engages in any commercial transactions with the Myanmar/Burmese military junta; or
3.1.16.2. is a representative, agent, affiliate, successor, attorney, or assign of the Myanmar/Burmese government;
3.1.17. Be an individual or entity, or a representative, agent, affiliate, successor, attorney, or assign of any individual or entity, that does business in, purchases goods from, or otherwise benefits from goods produced in the Xinjiang Uygur Autonomous Region of China;
3.1.18. Be an individual or entity:
3.1.18.1. which U.S. Customs and Border Protection (CBP) has currently issued a Withhold Release Order (WRO) or finding against based on reasonable suspicion of forced labor; or
3.1.18.2. that is a representative, agent, affiliate, successor, attorney, or assign of an individual or entity that does business with an individual or entity which currently has a WRO or finding from CBP issued against it based on reasonable suspicion of forced labor;
3.1.19. Be a government agency or multinational corporation, or a representative, agent, affiliate, successor, attorney, or assign of a government or multinational corporation, which participates in mass surveillance programs;
3.1.20. Be an entity or a representative, agent, affiliate, successor, attorney, or assign of an entity which conducts military activities;
3.1.21. Be an individual or entity, or a or a representative, agent, affiliate, successor, attorney, or assign of an individual or entity, that provides good or services to, or otherwise enters into any commercial contracts with, any local, state, or federal law enforcement agency;
3.1.22. Be an individual or entity, or a or a representative, agent, affiliate, successor, attorney, or assign of an individual or entity, that broadcasts messages promoting killing, torture, or other forms of extreme violence;
3.1.23. Interfere with Workers free exercise of the right to organize and associate +
(See Article 20, United Nations Universal Declaration of Human Rights; C087 - Freedom of Association and Protection of the Right to Organise Convention, 1948 (No. 87), International Labour Organization; Article 8, International Covenant on Economic, Social and Cultural Rights); and
3.1.24. Harm the environment in a manner inconsistent with local, state, national, or international law.
3.2. The Licensee SHALL:
3.2.1. Only use social auditing mechanisms that adhere to Worker-Driven Social Responsibility Networks Statement of Principles (https://wsr-network.org/what-is-wsr/statement-of-principles/) over traditional social auditing mechanisms, to the extent the Licensee uses any social auditing mechanisms at all;
3.2.2. Ensure that if the Licensee has a Board of Directors, 30% of Licensees board seats are held by Workers paid no more than 200% of the compensation of the lowest paid Worker of the Licensee;
3.2.3. Provide clear, accessible supply chain data to the public in accordance with the following conditions:
3.2.3.1. All data will be on Licensees website and/or, to the extent Licensee is a representative, agent, affiliate, successor, attorney, subsidiary, or assign, on Licensees principals or parents website or some other online platform accessible to the public via an internet search on a common internet search engine; and
3.2.3.2. Data published will include, where applicable, manufacturers, top tier suppliers, subcontractors, cooperatives, component parts producers, and farms;
3.2.4. Provide equal pay for equal work where the performance of such work requires equal skill, effort, and responsibility, and which are performed under similar working conditions, except where such payment is made pursuant to:
3.2.4.1. A seniority system;
3.2.4.2. A merit system;
3.2.4.3. A system which measures earnings by quantity or quality of production; or
3.2.4.4. A differential based on any other factor other than sex, gender, sexual orientation, race, ethnicity, nationality, religion, caste, age, medical disability or impairment, and/or any other like circumstances +
(See 29 U.S.C.A. § 206(d)(1); Article 23, _United Nations Universal Declaration of Human Rights_; Article 7, _International Covenant on Economic, Social and Cultural Rights_; Article 26, _International Covenant on Civil and Political Rights_); and
3.2.5. Allow for reasonable limitation of working hours and periodic holidays with pay +
(See Article 24, _United Nations Universal Declaration of Human Rights_; Article 7, _International Covenant on Economic, Social and Cultural Rights_).
== 4. SUPPLY CHAIN IMPACTED PARTIES
_This section identifies additional individuals or entities that a Licensee could harm as a result of violating the Ethical Standards section, the condition that the Licensee must voluntarily accept a Duty of Care for those individuals or entities, and the right to a private right of action that those individuals or entities possess as a result of violations of the Ethical Standards section._
4.1. In addition to the above Ethical Standards, Licensee voluntarily accepts a Duty of Care for Supply Chain Impacted Parties of this License, including individuals and communities impacted by violations of the Ethical Standards. The Duty of Care is breached when a provision within the Ethical Standards section is violated by a Licensee, one of its successors or assigns, or by an individual or entity that exists within the Supply Chain prior to a good or service reaching the Licensee.
4.2. Breaches of the Duty of Care, as stated within this section, shall create a private right of action, allowing any Supply Chain Impacted Party harmed by the Licensee to take legal action against the Licensee in accordance with applicable negligence laws, whether they be in tort law, delict law, and/or similar bodies of law closely related to tort and/or delict law, regardless if Licensee is directly responsible for the harms suffered by a Supply Chain Impacted Party. Nothing in this section shall be interpreted to include acts committed by individuals outside of the scope of his/her/their employment.
== 5. NOTICE
_This section explains when a Licensee must notify others of the License._
5.1. _Distribution of Notice_: Licensee must ensure that everyone who receives a copy of or uses any part of Software from Licensee, with or without changes, also receives the License and the copyright notice included with Software (and if included by the Licensor, patent, trademark, and attribution notice). Licensee must ensure that License is prominently displayed so that any individual or entity seeking to download, copy, use, or otherwise receive any part of Software from Licensee is notified of this License and its terms and conditions. Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software.
5.2. _Modified Software_: Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee, however, any derivative work stemming from the Software or its code must be distributed pursuant to this License, including this Notice provision.
5.3. _Recipients as Licensees_: Any individual or entity that uses, copies, modifies, reproduces, distributes, or prepares derivative work based upon the Software, all or part of the Softwares code, or a derivative work developed by using the Software, including a portion of its code, is a Licensee as defined above and is subject to the terms and conditions of this License.
== 6. REPRESENTATIONS AND WARRANTIES
6.1. _Disclaimer of Warranty_: TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES "AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR SHALL NOT BE LIABLE TO ANY PERSON OR ENTITY FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY LEGAL CLAIM.
6.2. _Limitation of Liability_: LICENSEE SHALL HOLD LICENSOR HARMLESS AGAINST ANY AND ALL CLAIMS, DEBTS, DUES, LIABILITIES, LIENS, CAUSES OF ACTION, DEMANDS, OBLIGATIONS, DISPUTES, DAMAGES, LOSSES, EXPENSES, ATTORNEYS FEES, COSTS, LIABILITIES, AND ALL OTHER CLAIMS OF EVERY KIND AND NATURE WHATSOEVER, WHETHER KNOWN OR UNKNOWN, ANTICIPATED OR UNANTICIPATED, FORESEEN OR UNFORESEEN, ACCRUED OR UNACCRUED, DISCLOSED OR UNDISCLOSED, ARISING OUT OF OR RELATING TO LICENSEES USE OF THE SOFTWARE. NOTHING IN THIS SECTION SHOULD BE INTERPRETED TO REQUIRE LICENSEE TO INDEMNIFY LICENSOR, NOR REQUIRE LICENSOR TO INDEMNIFY LICENSEE.
== 7. TERMINATION
7.1. _Violations of Ethical Standards or Breaching Duty of Care_: If Licensee violates the Ethical Standards section or Licensee, or any other person or entity within the Supply Chain prior to a good or service reaching the Licensee, breaches its Duty of Care to Supply Chain Impacted Parties, Licensee must remedy the violation or harm caused by Licensee within 30 days of being notified of the violation or harm. If Licensee fails to remedy the violation or harm within 30 days, all rights in the Software granted to Licensee by License will be null and void as between Licensor and Licensee.
7.2. _Failure of Notice_: If any person or entity notifies Licensee in writing that Licensee has not complied with the Notice section of this License, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice of noncompliance. If Licensee does not do so, Licensees License (and all rights licensed hereunder) will end immediately.
7.3. _Judicial Findings_: In the event Licensee is found by a civil, criminal, administrative, or other court of competent jurisdiction, or some other adjudicating body with legal authority, to have committed actions which are in violation of the Ethical Standards or Supply Chain Impacted Party sections of this License, all rights granted to Licensee by this License will terminate immediately.
7.4. _Patent Litigation_: If Licensee institutes patent litigation against any entity (including a cross-claim or counterclaim in a suit) alleging that the Software, all or part of the Softwares code, or a derivative work developed using the Software, including a portion of its code, constitutes direct or contributory patent infringement, then any patent license, along with all other rights, granted to Licensee under this License will terminate as of the date such litigation is filed.
7.5. _Additional Remedies_: Termination of the License by failing to remedy harms in no way prevents Licensor or Supply Chain Impacted Party from seeking appropriate remedies at law or in equity.
== 8. MISCELLANEOUS
8.1. _Conditions_: Sections 3, 4.1, 5.1, 5.2, 7.1, 7.2, 7.3, and 7.4 are conditions of the rights granted to Licensee in the License.
8.2. _Equitable Relief_: Licensor and any Supply Chain Impacted Party shall be entitled to equitable relief, including injunctive relief or specific performance of the terms hereof, in addition to any other remedy to which they are entitled at law or in equity.
8.3. _Copyleft_: Modified software, source code, or other derivative work must be licensed, in its entirety, under the exact same conditions as this License.
8.4. _Severability_: If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, any such determination of invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction. If the determination of invalidity, illegality, or unenforceability by a court of competent jurisdiction pertains to the terms or provisions contained in the Ethical Standards section of this License, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee.
8.5. _Section Titles_: Section titles are solely written for organizational purposes and should not be used to interpret the language within each section.
8.6. _Citations_: Citations are solely written to provide context for the source of the provisions in the Ethical Standards.
8.7. _Section Summaries_: Some sections have a brief _italicized description_ which is provided for the sole purpose of briefly describing the section and should not be used to interpret the terms of the License.
8.8. _Entire License_: This is the entire License between the Licensor and Licensee with respect to the claims released herein and that the consideration stated herein is the only consideration or compensation to be paid or exchanged between them for this License. This License cannot be modified or amended except in a writing signed by Licensor and Licensee.
8.9. _Successors and Assigns_: This License shall be binding upon and inure to the benefit of the Licensors and Licensees respective heirs, successors, and assigns.

View File

@@ -16,10 +16,10 @@ Config_ project is an opinionated configuration which meets the needs of my deve
but is also meant to serve as an example and guide for building your own personalized setup. Here is
how the two projects are meant to be used:
* *macOS* (this project) - The foundation framework for building customizated macOS machine setups.
* *macOS* (this project) - The foundational framework for building custom macOS machine setups.
* *link:https://www.alchemists.io/projects/mac_os-config[macOS Configuration]* - The layer on top of
this _macOS_ project which defines a custom machine setup and base implementation. The project is
meant to be forked for as many custom machine setups as needed.
this _macOS_ project which defines a custom machine implementation. The project is meant to be
forked for as many custom machine setups as needed.
toc::[]
@@ -28,15 +28,17 @@ toc::[]
* Provides a command line interface, written in Bash, with no additional dependencies for
installation and management of a macOS machine.
* Supports macOS boot disk creation for fresh install of operating system.
* Downloads and installs link:https://developer.apple.com/xcode[Xcode Command Line Tools].
* Downloads, installs, and configures link:http://brew.sh[Homebrew Formulas].
* Downloads, installs, and configures link:https://caskroom.github.io[Homebrew Casks].
* Downloads, installs, and configures link:http://www.apple.com/macosx/whats-new/app-store.html[App
Store] software.
* Downloads, installs, and configures non-App Store software applications.
* Downloads, installs, and configures software application extensions.
* Applies basic and default software settings.
* Sets up and configures installed software for use.
* Installs link:https://developer.apple.com/xcode[Xcode Command Line Tools].
* Installs link:http://brew.sh[Homebrew] formulas and casks.
* Installs link:http://www.apple.com/macosx/whats-new/app-store.html[App Store] software.
* Installs non-App Store software applications.
* Installs software application extensions.
* Installs dotfiles.
* Installs link:https://nodejs.org[Node] link:https://www.npmjs.com[packages].
* Installs link:https://www.ruby-lang.org[Ruby] link:https://rubygems.org[gems].
* Installs link:https://www.rust-lang.org[Rust] link:https://crates.io[crates].
* Applies basic default software settings.
* Configures installed software.
* Supports restoration of machine backups.
== Screencast
@@ -46,30 +48,18 @@ image::https://www.alchemists.io/images/screencasts/mac_os/cover.svg[Screencast,
== Requirements
. link:https://www.apple.com/macos/catalina[macOS]
. link:https://www.apple.com/macos/monterey[macOS Monterey]
. link:https://developer.apple.com/xcode[Xcode]
== Setup
=== Production
To install, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
git checkout 9.0.0
----
=== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
git checkout 15.0.0
----
== Usage
@@ -95,9 +85,13 @@ Install:
m: Install Mac App Store software.
a: Install application software.
x: Install application software extensions.
df: Install dotfiles.
np: Install Node packages.
rg: Install Ruby gems.
rc: Install Rust crates.
d: Apply default settings.
s: Setup installed software.
i: Install everything (i.e. executes all install options).
cs: Configure installed software.
i: Install everything (i.e. executes all install options in order listed).
Restore:
R: Restore settings from backup.
Manage:
@@ -138,64 +132,47 @@ macOS Boot Disk Tips
macOS Boot Disk Usage:
1. Insert the USB boot disk into the machine to be upgraded.
2. Reboot the machine.
3. Hold down the OPTION key before the Apple logo appears.
3. Hold the POWER (Silicon) or OPTION (Intel) key before the Apple logo appears.
4. Select the USB boot disk from the menu.
5. Use Disk Utility to format the machine's drive as "APFS (Encrypted)".
6. Install the new operating system.
5. Use Disk Utility to delete and/or erase the hard drive including associated partitions.
6. Use Disk Utility to create a single "APFS" drive as a "GUID Partition Table".
7. Install the new operating system.
macOS Reinstall:
1. Click the Apple icon from the operating system main menu.
2. Select the "Restart..." menu option.
3. Hold down the COMMAND+R keys before the Apple logo appears.
4. Wait for the macOS installer to load from the recovery partition.
5. Use the dialog options to launch Disk Utility, reinstall the system, etc.
macOS Boot Disk Recovery:
1. Start/restart the machine.
2. Hold the POWER (Silicon) or COMMAND+R (Intel) keys before the Apple logo appears.
3. Wait for the macOS installer to load from the recovery partition.
4. Use the dialog options to launch Disk Utility, reinstall the system, etc.
....
Depending on your security settings, you might need to use the Startup
Security Utility before using the Boot Disk (see below).
=== https://support.apple.com/en-us/HT208198[Startup Security Utility]
With newer hardware, you should be running with the Apple T2 Security Chip (found via  → About This
Mac → Overview → System Report → Controller). In order to boot your machine using the Boot Disk,
youll need to _temporarily_ disable the default security settings as follows:
* Turn on or restart your Mac, then press and hold `COMMAND + R` immediately after seeing the Apple
logo.
* Select Utilities → Startup Security Utility from the main menu.
* Click _Turn Off Firmware Password_.
* Select _Secure Boot: No Security_.
* Select _External Boot: Allow booting from external media_.
* Quit the utility and restart the machine.
Youll now be able to boot your system with the Boot Disk (see above).
After the new operating system has been installed via the Boot Disk, _ensure you return to the
Startup Security Utility and re-enable the following settings_:
* Click _Turn On Firmware Password_.
* Select _Secure Boot: Full Security_.
* Select _External Boot: Disallow booting from external or removable media_.
=== Customization
All executable scripts can be found in the `bin` folder:
* `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. _Can be
customized._
* `bin/apply_default_settings`: Applies useful system and application defaults. _Can be customized._
* `bin/create_boot_disk`: Creates macOS boot disk.
* `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. _Can be customized._
* `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. _Can be
customized._
* `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
* `bin/install_extensions`: Installs macOS application extensions and add-ons. _Can be customized._
* `bin/install_homebrew_casks`: Installs Homebrew Formulas. _Can be customized._
* `bin/install_homebrew_formulas`: Installs Homebrew Casks. _Can be customized._
* `bin/restore_backup`: Restores system/application settings from backup image. _Can be customized._
* `bin/run`: The main script and interface for macOS setup.
* `bin/setup_software`: Configures and launches (if necessary) installed software. _Can be
customized._
* `bin/apply_basic_settings` (optional, customizable): Applies basic and initial settings for
setting up a machine.
* `bin/apply_default_settings` (optional, customizable): Applies bare minimum system and application
defaults.
* `bin/configure_software` (optional, customizable): Configures installed software as part of the
post install process.
* `bin/create_boot_disk` (optional): Creates a macOS boot disk.
* `bin/install_app_store` (optional, customizable): Installs macOS, GUI-based, App Store
applications.
* `bin/install_applications` (optional, customizable): Installs macOS, GUI-based, non-App Store
applications.
* `bin/install_dev_tools` (required): Installs macOS development tools required by Homebrew.
* `bin/install_dotfiles` (optional, customizable): Installs personal dotfiles so the system is
tailored to your workflow.
* `bin/install_extensions` (optional, customizable): Installs macOS application extensions and
add-ons.
* `bin/install_homebrew_casks` (optional, customizable): Installs Homebrew Formulas.
* `bin/install_homebrew_formulas` (optional, customizable): Installs Homebrew Casks.
* `bin/install_node_packages` (optional, customizable): Installs Node packages.
* `bin/install_ruby_gems` (optional, customizable): Installs Ruby gems.
* `bin/install_rust_crates` (optional, customizable): Installs Rust crates.
* `bin/restore_backup` (optional, customizable): Restores system/application settings from backup
image.
* `bin/run` (required): The main script and interface for macOS setup.
The `lib` folder provides the base framework for installing, re-installing, and uninstalling
software. Everything provided via the link:https://www.alchemists.io/projects/mac_os-config[macOS
@@ -206,20 +183,41 @@ link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for
== Troubleshooting
* When using the boot disk, you might experience a situation where you see a black screen with a
white circle and diagonal line running through it. This means macOS lost or cant find the boot
disk for some reason. To correct this, shut down and boot up the system again while holding down
the `OPTION+COMMAND+R+P` keys simultaneously. You might want to wait for the system boot sound to
happen a few times before releasing the keys. This will clear the system NVRAM/PRAM. At this point
you can shut down and restart the system following the boot disk instructions (the boot disk will
be recognized now).
* Sometimes, when installing XCode development tools (i.e. the `t` option), not all of the macOS
headers will be installed. This can cause issues with compiling and building native packages. For
example: `fatal error: 'stdio.h' file not found`. This can happen due to an intermittent bug with
the XCode installer. To fix this, youll need to install this package:
`/Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg`. Depending on
your system, the version might differ, so look for a `*.pkg` in the
`/Library/Developer/CommandLineTools/Packages` folder.
* *Pi-hole*: When using link:https://pi-hole.net[Pi-hole], you might need to temporarily disable
prior to upgrading as you might experience various errors with Apple not being able to detect an
internet connection which prevents the installer from working.
* *Recovery Mode*: When using the boot disk and the installer fails in some catastrophic manner,
reboot the machine into recovery mode -- pass:[<kbd>POWER</kbd>] (Silicon) or
pass:[<kbd>COMMAND</kbd>] + pass:[<kbd>r</kbd>] (Intel) buttons -- to download and install the
last operating system used. Alternatively, you can also use pass:[<kbd>COMMAND</kbd>] +
pass:[<kbd>OPTION</kbd>] + pass:[<kbd>r</kbd>] (Intel) to attempt to download the latest operating
system.
* *NVRAM/PRAM Reset*: When using the boot disk, you might experience a situation where you see a
black screen with a white circle and diagonal line running through it. This means macOS lost or
can't find the boot disk for some reason. To correct this, shut down and boot up the system again
while holding down pass:[<kbd>OPTION</kbd>] + pass:[<kbd>COMMAND</kbd>] + pass:[<kbd>r</kbd>] +
pass:[<kbd>p</kbd>] (Intel) keys simultaneously. You might want to wait for the system boot sound
to happen a few times before releasing the keys. This will clear the system NVRAM/PRAM. At this
point you can shut down and restart the system following the boot disk instructions (the boot disk
will be recognized now).
* *System Management Controller (SMC) Reset*: Sometimes it can help to reset the SMC to improve
system speed. To fix, follow these steps:
** Shut down your Mac.
** Hold down pass:[<kbd>CONTROL</kbd>] + pass:[<kbd>OPTION</kbd>] on the left side of the keyboard
and pass:[<kbd>SHIFT</kbd>] on the right side of the keyboard.
** After seven seconds, hold down the Power button as well.
** Release all keys after another seven seconds.
** Turn on your Mac.
== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
----
== Versioning
@@ -238,11 +236,16 @@ participating in this project you agree to abide by its terms.
Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
== Community
Feel free to link:https://www.alchemists.io/community[join the commmunity] for discussions related
to this project and much more.
== License
Read link:LICENSE.adoc[LICENSE] for details.
== History
== Changes
Read link:CHANGES.adoc[CHANGES] for details.

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_basic_settings"
if [[ -x "$SCRIPT_PATH" ]]; then

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_default_settings"
if [[ -x "$SCRIPT_PATH" ]]; then

16
bin/configure_software Executable file
View File

@@ -0,0 +1,16 @@
#! /usr/bin/env bash
# Configures installed software.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/configure_software"
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else
printf "WARNING: Configure software script does not exist or is not executable.\n"
fi

View File

@@ -9,16 +9,16 @@ printf " - Use Disk Utility to label the USB drive as \"Untitled\".\n"
printf "\nmacOS Boot Disk Usage:\n"
printf " 1. Insert the USB boot disk into the machine to be upgraded.\n"
printf " 2. Reboot the machine.\n"
printf " 3. Hold down the OPTION key before the Apple logo appears.\n"
printf " 3. Hold the POWER (Silicon) or OPTION (Intel) key before the Apple logo appears.\n"
printf " 4. Select the USB boot disk from the menu.\n"
printf " 5. Use Disk Utility to format the machine's drive as \"APFS (Encrypted)\".\n"
printf " 6. Install the new operating system.\n"
printf "\nmacOS Reinstall:\n"
printf " 1. Click the Apple icon from the operating system main menu.\n"
printf " 2. Select the \"Restart...\" menu option.\n"
printf " 3. Hold down the COMMAND+R keys before the Apple logo appears.\n"
printf " 4. Wait for the macOS installer to load from the recovery partition.\n"
printf " 5. Use the dialog options to launch Disk Utility, reinstall the system, etc.\n"
printf " 5. Use Disk Utility to delete and/or erase the hard drive including associated partitions.\n"
printf " 6. Use Disk Utility to create a single \"APFS\" drive as a \"GUID Partition Table\".\n"
printf " 7. Install the new operating system.\n"
printf "\nmacOS Boot Disk Recovery:\n"
printf " 1. Start/restart the machine.\n"
printf " 2. Hold the POWER (Silicon) or COMMAND+R (Intel) keys before the Apple logo appears.\n"
printf " 3. Wait for the macOS installer to load from the recovery partition.\n"
printf " 4. Use the dialog options to launch Disk Utility, reinstall the system, etc.\n"
printf "\nCreating macOS boot disk...\n"

View File

@@ -6,9 +6,11 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_app_store"
if [[ -x "$SCRIPT_PATH" ]]; then
check_mas_install
"$SCRIPT_PATH"
else
printf "WARNING: App Store install script does not exist or is not executable.\n"

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_applications"
if [[ -x "$SCRIPT_PATH" ]]; then

View File

@@ -1,6 +1,6 @@
#! /usr/bin/env bash
# Installs development tooling requirements.
Installs development tooling requirements.
printf "Installing Xcode CLI tools...\n"
xcode-select --install
@@ -11,3 +11,7 @@ if [[ "$xcode_response" != "y" ]]; then
printf "ERROR: Xcode CLI tools must be installed before proceeding.\n"
exit 1
fi
if [[ "$(/usr/bin/arch)" == "arm64" ]]; then
softwareupdate --install-rosetta --agree-to-license
fi

16
bin/install_dotfiles Executable file
View File

@@ -0,0 +1,16 @@
#! /usr/bin/env bash
# Installs dotfiles.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_dotfiles"
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else
printf "WARNING: Dotfiles install script does not exist or is not executable.\n"
fi

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_extensions"
if [[ -x "$SCRIPT_PATH" ]]; then

View File

@@ -6,9 +6,11 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
if [[ -x "$SCRIPT_PATH" ]]; then
install_homebrew
"$SCRIPT_PATH"
else
printf "WARNING: Homebrew Casks install script does not exist or is not executable.\n"

View File

@@ -6,9 +6,11 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
if [[ -x "$SCRIPT_PATH" ]]; then
install_homebrew
"$SCRIPT_PATH"
else
printf "WARNING: Homebrew Formulas install script does not exist or is not executable.\n"

17
bin/install_node_packages Executable file
View File

@@ -0,0 +1,17 @@
#! /usr/bin/env bash
# Installs Node packages.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_node_packages"
if [[ -x "$SCRIPT_PATH" ]]; then
install_node
"$SCRIPT_PATH"
else
printf "WARNING: Node packages install script does not exist or is not executable.\n"
fi

17
bin/install_ruby_gems Executable file
View File

@@ -0,0 +1,17 @@
#! /usr/bin/env bash
# Installs Ruby gems.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_ruby_gems"
if [[ -x "$SCRIPT_PATH" ]]; then
install_ruby
"$SCRIPT_PATH"
else
printf "WARNING: Ruby gems install script does not exist or is not executable.\n"
fi

17
bin/install_rust_crates Executable file
View File

@@ -0,0 +1,17 @@
#! /usr/bin/env bash
# Installs Rust crates.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_rust_crates"
if [[ -x "$SCRIPT_PATH" ]]; then
install_rust
"$SCRIPT_PATH"
else
printf "WARNING: Rust crates install script does not exist or is not executable.\n"
fi

View File

@@ -6,6 +6,7 @@ set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/restore_backup"
if [[ -x "$SCRIPT_PATH" ]]; then

10
bin/run
View File

@@ -23,6 +23,8 @@ else
exit 1
fi
configure_environment
while true; do
if [[ $# == 0 ]]; then
printf "\nUsage: run OPTION\n"
@@ -37,9 +39,13 @@ while true; do
printf " m: Install Mac App Store software.\n"
printf " a: Install application software.\n"
printf " x: Install application software extensions.\n"
printf " df: Install dotfiles.\n"
printf " np: Install Node packages.\n"
printf " rg: Install Ruby gems.\n"
printf " rc: Install Rust crates.\n"
printf " d: Apply default settings.\n"
printf " s: Setup installed software.\n"
printf " i: Install everything (i.e. executes all install options).\n"
printf " cs: Configure installed software.\n"
printf " i: Install all (i.e. executes all of the above steps in order listed).\n"
printf " Restore:\n"
printf " R: Restore settings from backup.\n"
printf " Manage:\n"

View File

@@ -1,15 +0,0 @@
#! /usr/bin/env bash
# Sets up and launches (if necessary) installed software.
set -o nounset
set -o errexit
set -o pipefail
IFS=$'\n\t'
SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/setup_software"
if [[ -x "$SCRIPT_PATH" ]]; then
"$SCRIPT_PATH"
else
printf "WARNING: Software setup script does not exist or is not executable.\n"
fi

View File

@@ -1,61 +0,0 @@
version: 2
jobs:
build:
working_directory: ~/project
docker:
- image: circleci/ruby
environment:
BUNDLE_JOBS: 3
BUNDLE_RETRY: 3
BUNDLE_PATH: vendor/bundle
EDITOR: vim
steps:
- checkout
- run:
name: Environment Setup
command: |
printf "%s\n" 'export CI_RUBY_VERSION=$(cat ".ruby-version" | tr -d "\n")' >> $BASH_ENV
- type: cache-restore
name: Ruby Restore
key: ruby-{{checksum ".ruby-version"}}
- run:
name: Ruby Install
command: |
curl https://cache.ruby-lang.org/pub/ruby/${CI_RUBY_VERSION::-2}/ruby-$CI_RUBY_VERSION.tar.bz2 > ../ruby-$CI_RUBY_VERSION.tar.gz
cd ..
tar --extract --bzip2 --verbose --file ruby-$CI_RUBY_VERSION.tar.gz
cd ruby-$CI_RUBY_VERSION
./configure
make
make update-gems
make extract-gems
sudo make install
- type: cache-save
name: Ruby Store
key: ruby-{{checksum ".ruby-version"}}
paths:
- ../ruby-$CI_RUBY_VERSION
- type: cache-restore
name: Bundler Restore
key: bundler-{{checksum "Gemfile"}}
- run:
name: Bundler Install
command: |
gem update --system
bundle install --path vendor/bundle
- type: cache-save
name: Bundler Store
key: bundler-{{checksum "Gemfile"}}
paths:
- vendor/bundle
- run:
name: Build
command: bundle exec rake

View File

@@ -2,6 +2,43 @@
# Defines software installer functions.
# Downloads remote file to local disk.
# Parameters: $1 (required) - URL, $2 (required) - File name, $3 (optional) - HTTP header.
download_file() {
local url="$1"
local file_name="$2"
local http_header="$3"
printf "%s\n" "Downloading $1..."
clean_work_path
mkdir $MAC_OS_WORK_PATH
curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
}
export -f download_file
# Installs an application.
# Parameters: $1 (required) - Application source path, $2 (required) - Application name.
install_app() {
local install_root=$(get_install_root "$2")
local file_extension=$(get_extension "$2")
printf "Installing: $install_root/$2...\n"
case $file_extension in
'')
cp -a "$1/$2" "$install_root";;
'app')
cp -a "$1/$2" "$install_root";;
'prefPane')
sudo cp -pR "$1/$2" "$install_root";;
'qlgenerator')
sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
*)
printf "ERROR: Unknown file extension: $file_extension.\n"
esac
}
export -f install_app
# Installs an application via a DMG file.
# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
install_dmg_app() {
@@ -41,6 +78,172 @@ install_dmg_pkg() {
}
export -f install_dmg_pkg
# Installs a single file.
# Parameters: $1 (required) - URL, $2 (required) - Install path.
install_file() {
local file_url="$1"
local file_name=$(get_basename "$1")
local install_path="$2"
if [[ ! -e "$install_path" ]]; then
download_file "$file_url" "$file_name"
mkdir -p $(dirname "$install_path")
mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
printf "Installed: $file_name.\n"
verify_path "$install_path"
fi
}
export -f install_file
# Installs application code from a Git repository.
# Parameters: $1 (required) - Repository URL, $2 (required) - Install path, $3 (optional) - Git clone options.
install_git_app() {
local repository_url="$1"
local app_name=$(get_basename "$2")
local install_path="$2"
local options="--quiet"
if [[ -n "$3" ]]; then
local options="$options $3"
fi
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path/$app_name...\n"
git clone $options "$repository_url" "$install_path"
printf "Installed: $app_name.\n"
verify_path "$install_path"
fi
}
export -f install_git_app
# Installs settings from a Git repository.
# Parameters: $1 (required) - Repository URL, $2 (required) - Repository version, $3 (required) - Project directory, $4 (required) - Script to run (including any arguments).
install_git_project() {
local repo_url="$1"
local repo_version="$2"
local project_dir="$3"
local script="$4"
git clone "$repo_url"
(
cd "$project_dir"
git -c advice.detachedHead=false checkout "$repo_version"
eval "$script"
)
rm -rf "$project_dir"
}
export -f install_git_project
# Installs Homebrew.
# Parameters: None.
install_homebrew() {
if ! command -v brew > /dev/null; then
/bin/bash -c "$(curl --location --fail --silent --show-error https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
fi
}
export -f install_homebrew
# Installs a package via a zip file.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_bare_pkg() {
local url="$1"
local app_name="$2"
local install_path=$(get_install_path "$app_name")
local work_file="$app_name.pkg"
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$work_file"
install_pkg "$MAC_OS_WORK_PATH" "$app_name"
printf "Installed: $app_name.\n"
verify_application "$app_name"
fi
}
export -f install_bare_pkg
# Installs a package.
# Parameters: $1 (required) - Package source path, $2 (required) - Application name.
install_pkg() {
local install_root=$(get_install_root "$2")
printf "Installing: $install_root/$2...\n"
local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
sudo installer -pkg "$package" -target /
}
export -f install_pkg
# Installs program (single file).
# Parameters: $1 (required) - URL, $2 (required) - Program name.
install_program() {
local url="$1"
local program_name="$2"
local install_path=$(get_install_path "$program_name")
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$program_name"
mv "$MAC_OS_WORK_PATH/$program_name" "$install_path"
chmod 755 "$install_path"
printf "Installed: $program_name.\n"
verify_application "$program_name"
fi
}
export -f install_program
# Installs Node.
# Parameters: None.
install_node() {
if ! command -v fnm > /dev/null; then
$(get_homebrew_bin_root)/fnm install --lts
fi
}
export -f install_node
# Installs Ruby.
# Parameters: None.
install_ruby() {
local version="$(cat $HOME/.ruby-version | tr -d '\n')"
if [[ ! -x "$(command -v ruby)" && -n $(ruby --version | grep --quiet "$version") ]]; then
$(get_homebrew_bin_root)/frum install "$version"
$(get_homebrew_bin_root)/frum local "$version"
gem update --system && gem update
fi
}
export -f install_ruby
# Installs Rust.
# Parameters: None.
install_rust() {
if ! command -v cargo > /dev/null; then
curl --proto "=https" --tlsv1.2 --fail --silent --show-error https://sh.rustup.rs | sh
fi
}
export -f install_rust
# Installs an application via a tar file.
# Parameters: $1 (required) - URL, $2 (required) - Application name, $3 (required) - Decompress options.
install_tar_app() {
local url="$1"
local app_name="$2"
local options="$3"
local install_path=$(get_install_path "$app_name")
local work_file="download.tar"
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$work_file"
(
printf "Preparing...\n"
cd "$MAC_OS_WORK_PATH"
tar "$options" "$work_file"
)
install_app "$MAC_OS_WORK_PATH" "$app_name"
printf "Installed: $app_name.\n"
verify_application "$app_name"
fi
}
export -f install_tar_app
# Installs an application via a zip file.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_zip_app() {
@@ -90,152 +293,6 @@ install_zip_pkg() {
}
export -f install_zip_pkg
# Installs an application via a tar file.
# Parameters: $1 (required) - URL, $2 (required) - Application name, $3 (required) - Decompress options.
install_tar_app() {
local url="$1"
local app_name="$2"
local options="$3"
local install_path=$(get_install_path "$app_name")
local work_file="download.tar"
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$work_file"
(
printf "Preparing...\n"
cd "$MAC_OS_WORK_PATH"
tar "$options" "$work_file"
)
install_app "$MAC_OS_WORK_PATH" "$app_name"
printf "Installed: $app_name.\n"
verify_application "$app_name"
fi
}
export -f install_tar_app
# Installs program (single file).
# Parameters: $1 (required) - URL, $2 (required) - Program name.
install_program() {
local url="$1"
local program_name="$2"
local install_path=$(get_install_path "$program_name")
if [[ ! -e "$install_path" ]]; then
download_file "$url" "$program_name"
mv "$MAC_OS_WORK_PATH/$program_name" "$install_path"
chmod 755 "$install_path"
printf "Installed: $program_name.\n"
verify_application "$program_name"
fi
}
export -f install_program
# Installs application code from a Git repository.
# Parameters: $1 (required) - Repository URL, $2 (required) - Install path, $3 (optional) - Git clone options.
install_git_app() {
local repository_url="$1"
local app_name=$(get_basename "$2")
local install_path="$2"
local options="--quiet"
if [[ -n "$3" ]]; then
local options="$options $3"
fi
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path/$app_name...\n"
git clone $options "$repository_url" "$install_path"
printf "Installed: $app_name.\n"
verify_path "$install_path"
fi
}
export -f install_git_app
# Installs settings from a Git repository.
# Parameters: $1 (required) - Repository URL, $2 (required) - Repository version, $3 (required) - Project directory, $4 (required) - Script to run (including any arguments).
install_git_project() {
local repo_url="$1"
local repo_version="$2"
local project_dir="$3"
local script="$4"
git clone "$repo_url"
(
cd "$project_dir"
git -c advice.detachedHead=false checkout "$repo_version"
eval "$script"
)
rm -rf "$project_dir"
}
export -f install_git_project
# Installs a single file.
# Parameters: $1 (required) - URL, $2 (required) - Install path.
install_file() {
local file_url="$1"
local file_name=$(get_basename "$1")
local install_path="$2"
if [[ ! -e "$install_path" ]]; then
download_file "$file_url" "$file_name"
mkdir -p $(dirname "$install_path")
mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
printf "Installed: $file_name.\n"
verify_path "$install_path"
fi
}
export -f install_file
# Downloads remote file to local disk.
# Parameters: $1 (required) - URL, $2 (required) - File name, $3 (optional) - HTTP header.
download_file() {
local url="$1"
local file_name="$2"
local http_header="$3"
printf "%s\n" "Downloading $1..."
clean_work_path
mkdir $MAC_OS_WORK_PATH
curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
}
export -f download_file
# Installs an application.
# Parameters: $1 (required) - Application source path, $2 (required) - Application name.
install_app() {
local install_root=$(get_install_root "$2")
local file_extension=$(get_extension "$2")
printf "Installing: $install_root/$2...\n"
case $file_extension in
'')
cp -a "$1/$2" "$install_root";;
'app')
cp -a "$1/$2" "$install_root";;
'prefPane')
sudo cp -pR "$1/$2" "$install_root";;
'qlgenerator')
sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
*)
printf "ERROR: Unknown file extension: $file_extension.\n"
esac
}
export -f install_app
# Installs a package.
# Parameters: $1 (required) - Package source path, $2 (required) - Application name.
install_pkg() {
local install_root=$(get_install_root "$2")
printf "Installing: $install_root/$2...\n"
local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
sudo installer -pkg "$package" -target /
}
export -f install_pkg
# Mounts a disk image.
# Parameters: $1 (required) - Image path.
mount_image() {

View File

@@ -22,10 +22,18 @@ process_option() {
bin/install_applications;;
'x')
bin/install_extensions;;
'df')
bin/install_dotfiles;;
'np')
bin/install_node_packages;;
'rg')
bin/install_ruby_gems;;
'rc')
bin/install_rust_crates;;
'd')
bin/apply_default_settings;;
's')
bin/setup_software;;
'cs')
bin/configure_software;;
'i')
caffeinate_machine
bin/apply_basic_settings
@@ -35,17 +43,25 @@ process_option() {
bin/install_app_store
bin/install_applications
bin/install_extensions
bin/install_dotfiles
bin/install_node_packages
bin/install_ruby_gems
bin/install_rust_crates
bin/apply_default_settings
bin/setup_software
bin/configure_software
clean_work_path;;
'R')
caffeinate_machine
bin/restore_backup;;
'c')
verify_homebrew_formulas
verify_homebrew_casks
verify_app_store_applications
verify_applications
verify_extensions;;
verify_extensions
verify_node_packages
verify_ruby_gems
verify_rust_crates;;
'C')
caffeinate_machine;;
'ua')

View File

@@ -5,7 +5,7 @@ set -o errexit
set -o pipefail
IFS=$'\n\t'
export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Catalina.app/Contents/Resources/createinstallmedia"
export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Monterey.app/Contents/Resources/createinstallmedia"
export MAC_OS_BOOT_DISK_PATH="/Volumes/Untitled"
export MAC_OS_WORK_PATH=/tmp/downloads
export MAC_OS_CONFIG_PATH="../mac_os-config"

View File

@@ -15,43 +15,12 @@ caffeinate_machine() {
}
export -f caffeinate_machine
# Answers the full install path (including file name) for file name.
# Parameters: $1 (required) - The file name.
get_install_path() {
local file_name="$1"
local install_path=$(get_install_root "$file_name")
printf "$install_path/$file_name"
}
export -f get_install_path
# Cleans work path for temporary processing of installs.
clean_work_path() {
rm -rf "$MAC_OS_WORK_PATH"
}
export -f clean_work_path
# Answers the root install path for file name.
# Parameters: $1 (required) - The file name.
get_install_root() {
local file_name="$1"
local file_extension=$(get_extension "$file_name")
# Dynamically build the install path based on file extension.
case $file_extension in
'')
printf "/usr/local/bin";;
'app')
printf "/Applications";;
'prefPane')
printf "/Library/PreferencePanes";;
'qlgenerator')
printf "/Library/QuickLook";;
*)
printf "/tmp/unknown";;
esac
}
export -f get_install_root
# Answers the file or directory basename.
# Parameters: $1 (required) - The file path.
get_basename() {
@@ -72,3 +41,87 @@ get_extension() {
fi
}
export -f get_extension
# Answers Homebrew root path.
# Parameters: None.
get_homebrew_root() {
if [[ "$(/usr/bin/arch)" == "arm64" ]]; then
printf "%s" "/opt/homebrew"
else
printf "%s" "/usr/local/Homebrew"
fi
}
export -f get_homebrew_root
# Answers Homebrew binary root path.
# Parameters: None.
get_homebrew_bin_root() {
if [[ "$(/usr/bin/arch)" == "arm64" ]]; then
printf "%s" "/opt/homebrew/bin"
else
printf "%s" "/usr/local/bin"
fi
}
export -f get_homebrew_bin_root
# Answers the full install path (including file name) for file name.
# Parameters: $1 (required) - The file name.
get_install_path() {
local file_name="$1"
local install_path=$(get_install_root "$file_name")
printf "$install_path/$file_name"
}
export -f get_install_path
# Answers the root install path for file name.
# Parameters: $1 (required) - The file name.
get_install_root() {
local file_name="$1"
local file_extension=$(get_extension "$file_name")
# Special cases not supported by Homebrew.
if [[ "$file_name" == "elm" ]]; then
printf "/usr/local/bin"
return
fi
# Dynamically build the install path based on file extension.
case $file_extension in
'')
printf "$(get_homebrew_bin_root)";;
'app')
printf "/Applications";;
'prefPane')
printf "/Library/PreferencePanes";;
'qlgenerator')
printf "/Library/QuickLook";;
*)
printf "/tmp/unknown";;
esac
}
export -f get_install_root
# Checks Mac App Store (mas) CLI has been installed and exits if otherwise.
# Parameters: None.
check_mas_install() {
if ! command -v mas > /dev/null; then
printf "%s\n" "ERROR: Mac App Store (mas) CLI can't be found."
printf "%s\n" " Please ensure Homebrew and mas (i.e. brew install mas) have been installed."
exit 1
fi
}
export -f check_mas_install
# Configures shell for new machines and ensures PATH is properly configured for running scripts.
# Parameters: None.
configure_environment() {
if [[ ! -s "$HOME/.bash_profile" ]]; then
printf "%s\n" "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" > "$HOME/.bash_profile"
fi
if [[ ! -s "$HOME/.bashrc" ]]; then
printf "%s\n" 'export PATH="/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"' > "$HOME/.bashrc"
source "$HOME/.bashrc"
fi
}
export -f configure_environment

View File

@@ -2,46 +2,6 @@
# Defines verification/validation functions.
# Checks for missing Homebrew formulas.
verify_homebrew_formulas() {
printf "Checking Homebrew formulas...\n"
local applications="$(brew list)"
while read line; do
if [[ "$line" == "brew install"* ]]; then
local application=$(printf "$line" | awk '{print $3}')
# Exception: "gpg" is the binary but is listed as "gnugp".
if [[ "$application" == "gpg" ]]; then
application="gnupg"
fi
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
printf "Homebrew formula check complete.\n"
}
export -f verify_homebrew_formulas
# Checks for missing Homebrew casks.
verify_homebrew_casks() {
printf "\nChecking Homebrew casks...\n"
local applications="$(brew list --cask)"
while read line; do
if [[ "$line" == "brew cask install"* ]]; then
local application=$(printf "$line" | awk '{print $4}')
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
printf "Homebrew cask check complete.\n"
}
export -f verify_homebrew_casks
# Checks for missing App Store applications.
verify_app_store_applications() {
printf "\nChecking App Store applications...\n"
@@ -59,17 +19,17 @@ verify_app_store_applications() {
}
export -f verify_app_store_applications
# Verifies listed application exists.
# Parameters: $1 (required) - The current application, $2 (required) - The application list.
verify_listed_application() {
local application="$1"
local applications="$2"
# Verifies application exists.
# Parameters: $1 (required) - The file name.
verify_application() {
local file_name="$1"
local install_path=$(get_install_path "$file_name")
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
fi
}
export -f verify_listed_application
export -f verify_application
# Checks for missing applications suffixed by "APP_NAME" as defined in settings.sh.
verify_applications() {
@@ -87,18 +47,6 @@ verify_applications() {
}
export -f verify_applications
# Verifies application exists.
# Parameters: $1 (required) - The file name.
verify_application() {
local file_name="$1"
local install_path=$(get_install_path "$file_name")
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
fi
}
export -f verify_application
# Checks for missing extensions suffixed by "EXTENSION_PATH" as defined in settings.sh.
verify_extensions() {
printf "\nChecking application extensions...\n"
@@ -116,6 +64,58 @@ verify_extensions() {
}
export -f verify_extensions
# Checks for missing Homebrew casks.
verify_homebrew_casks() {
printf "\nChecking Homebrew casks...\n"
local applications="$(brew list --casks)"
while read line; do
if [[ "$line" == "brew cask install"* ]]; then
local application=$(printf "$line" | awk '{print $4}')
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
printf "Homebrew cask check complete.\n"
}
export -f verify_homebrew_casks
# Checks for missing Homebrew formulas.
verify_homebrew_formulas() {
printf "Checking Homebrew formulas...\n"
local applications="$(brew list --formulae)"
while read line; do
if [[ "$line" == "brew install"* ]]; then
local application=$(printf "$line" | awk '{print $3}')
# Exception: "gpg" is the binary but is listed as "gnugp".
if [[ "$application" == "gpg" ]]; then
application="gnupg"
fi
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
printf "Homebrew formula check complete.\n"
}
export -f verify_homebrew_formulas
# Verifies listed application exists.
# Parameters: $1 (required) - The current application, $2 (required) - The application list.
verify_listed_application() {
local application="$1"
local applications="$2"
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
fi
}
export -f verify_listed_application
# Verifies path exists.
# Parameters: $1 (required) - The path.
verify_path() {
@@ -126,3 +126,54 @@ verify_path() {
fi
}
export -f verify_path
# Checks for missing Node packages.
verify_node_packages() {
printf "\nChecking Node packages...\n"
while read line; do
if [[ "$line" == "npm "* ]]; then
local package=$(printf "$line" | awk '{print $4}')
local packages=($(npm list --global --depth=0 | grep "$package"))
verify_listed_application "$package" "${packages[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_node_packages"
printf "Node packages check complete.\n"
}
export -f verify_node_packages
# Checks for missing Ruby gems.
verify_ruby_gems() {
local gems="$(gem list --no-versions)"
printf "\nChecking Ruby gems...\n"
while read line; do
if [[ "$line" == "gem install"* ]]; then
local gem=$(printf "$line" | awk '{print $3}')
verify_listed_application "$gem" "${gems[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_ruby_gems"
printf "Ruby gems check complete.\n"
}
export -f verify_ruby_gems
# Checks for missing Rust crates.
verify_rust_crates() {
printf "\nChecking Rust crates...\n"
local crates="$(ls -A1 $HOME/.cargo/bin)"
while read line; do
if [[ "$line" == "cargo install"* ]]; then
local crate=$(printf "$line" | awk '{print $3}')
verify_listed_application "$crate" "${crates[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_rust_crates"
printf "Rust crates check complete.\n"
}
export -f verify_rust_crates