From b6e6b3bd5846f418859de305748f8c9d9c0ee721 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Thu, 5 Sep 2024 15:38:36 +0100 Subject: [PATCH] Migrate Strap to GitHub Pages This drops some of the dynamic features but: - I no longer want to pay for DigitalOcean out of my own pocket. - Workbrew's Bootstrap feature does everything better than Strap does at this point. --- .github/codeql.yml | 2 - .github/dependabot.yml | 24 -- .github/workflows/codeql.yml | 26 -- .github/workflows/tests.yml | 67 +--- .gitignore | 10 +- .rubocop.yml | 27 -- CNAME | 1 + Dockerfile | 22 -- Gemfile | 18 +- Gemfile.lock | 169 --------- Guardfile | 8 - LICENSE.txt | 680 ++++++++++++++++++++++++++++++++++- README.md | 58 ++- _config.yml | 41 +++ config.ru | 4 - index.html | 78 ++++ robots.txt | 5 + script/bootstrap | 4 - script/server | 3 +- script/style | 28 +- script/tests | 21 +- bin/strap.sh => strap.sh | 208 +++-------- web/app.rb | 189 ---------- web/puma.rb | 28 -- web/views/root.erb | 53 --- 25 files changed, 883 insertions(+), 891 deletions(-) delete mode 100644 .github/codeql.yml delete mode 100644 .github/workflows/codeql.yml delete mode 100644 .rubocop.yml create mode 100644 CNAME delete mode 100644 Dockerfile delete mode 100644 Gemfile.lock delete mode 100644 Guardfile create mode 100644 _config.yml delete mode 100644 config.ru create mode 100644 index.html create mode 100644 robots.txt rename bin/strap.sh => strap.sh (58%) delete mode 100644 web/app.rb delete mode 100644 web/puma.rb delete mode 100644 web/views/root.erb diff --git a/.github/codeql.yml b/.github/codeql.yml deleted file mode 100644 index f18f377d1..000000000 --- a/.github/codeql.yml +++ /dev/null @@ -1,2 +0,0 @@ -paths-ignore: - - vendor diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e1c2a7163..dabfd2a15 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -11,27 +11,3 @@ updates: github-actions: patterns: - "*" - - - package-ecosystem: bundler - directory: / - schedule: - interval: daily - time: "07:30" - timezone: "Europe/London" - allow: - - dependency-type: all - groups: - bundler: - patterns: - - "*" - - - package-ecosystem: "docker" - directory: "/" - schedule: - interval: daily - time: "08:00" - timezone: "Europe/London" - groups: - docker: - patterns: - - "*" diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml deleted file mode 100644 index 9ea9cb82d..000000000 --- a/.github/workflows/codeql.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: CodeQL -on: - push: - branches: - - main - pull_request: - branches: - - main - schedule: - - cron: "39 8 * * 5" -jobs: - analyze: - runs-on: ubuntu-latest - steps: - - name: Set up Git repository - uses: actions/checkout@v4 - - - name: Set up CodeQL - uses: github/codeql-action/init@v3 - with: - languages: ruby - queries: security-and-quality - config-file: ./.github/codeql.yml - - - name: Perform CodeQL analysis - uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index cdf97b786..e8d4b8761 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -47,13 +47,13 @@ jobs: - name: Use newer Xcode run: sudo xcode-select --switch /Applications/Xcode_15.2.app/Contents/Developer - - run: bin/strap.sh + - run: ./strap.sh env: STRAP_CI: 1 STRAP_DEBUG: 1 - - name: Rerun bin/strap.sh - run: bin/strap.sh + - name: Rerun ./strap.sh + run: ./strap.sh env: STRAP_CI: 1 @@ -78,64 +78,3 @@ jobs: - run: brew install --cask orka - run: brew install --formula xz - - docker: - runs-on: ubuntu-latest - steps: - - name: Set up Git repository - uses: actions/checkout@v4 - - - name: Set RUBY_VERSION - run: | - set -xeuo pipefail - - RUBY_VERSION=$(cat .ruby-version) - echo "RUBY_VERSION=${RUBY_VERSION}" >> "${GITHUB_ENV}" - - - uses: docker/setup-buildx-action@v3 - - - name: Login to GitHub Packages - uses: docker/login-action@v3 - with: - registry: ghcr.io - username: mikemcquaid - password: ${{ secrets.GITHUB_TOKEN }} - - # We don't give Dependabot access to tokens. - - if: github.actor != 'dependabot[bot]' - name: Login to Docker Hub - uses: docker/login-action@v3 - with: - username: mikemcquaid - password: ${{ secrets.DOCKER_TOKEN }} - - # We don't give Dependabot access to tokens. - - if: github.actor != 'dependabot[bot]' - name: Login to DigitalOcean - uses: digitalocean/action-doctl@v2 - with: - token: ${{ secrets.DIGITAL_OCEAN_TOKEN }} - - # We don't give Dependabot access to tokens. - - if: github.actor != 'dependabot[bot]' - run: doctl registry login --expiry-seconds 300 - - # We don't give Dependabot access to tokens. - - if: github.actor != 'dependabot[bot]' - run: doctl registry garbage-collection start --include-untagged-manifests --force - - - uses: docker/build-push-action@v6 - with: - push: ${{ github.ref == 'refs/heads/main' }} - tags: | - mikemcquaid/strap:latest - mikemcquaid/strap:main - mikemcquaid/strap:master - ghcr.io/mikemcquaid/strap:latest - ghcr.io/mikemcquaid/strap:main - ghcr.io/mikemcquaid/strap:master - registry.digitalocean.com/mikemcquaid/strap:latest - cache-from: type=gha - cache-to: type=gha,mode=max - build-args: | - RUBY_VERSION=${{ env.RUBY_VERSION }} diff --git a/.gitignore b/.gitignore index 71652cf4e..0d1ec82f1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,6 @@ -/.env /.bundle/ -/.vagrant/ -/bin/* -!/bin/strap.sh +/bin/ /vendor/ -Vagrantfile -strap.sh +/_site/ +/Gemfile.lock +/.jekyll-metadata diff --git a/.rubocop.yml b/.rubocop.yml deleted file mode 100644 index 612c7bcee..000000000 --- a/.rubocop.yml +++ /dev/null @@ -1,27 +0,0 @@ -AllCops: - TargetRubyVersion: 2.7 - NewCops: enable - Exclude: - - "**/vendor/**/*" - -Layout/EndAlignment: - EnforcedStyleAlignWith: start_of_line - -Layout/HashAlignment: - EnforcedHashRocketStyle: table - EnforcedColonStyle: table - -Layout/LineLength: - Max: 118 - -Metrics/BlockLength: - Enabled: false - -Style/StringLiterals: - EnforcedStyle: double_quotes - -Style/TrailingCommaInArrayLiteral: - EnforcedStyleForMultiline: consistent_comma - -Style/TrailingCommaInHashLiteral: - EnforcedStyleForMultiline: consistent_comma diff --git a/CNAME b/CNAME new file mode 100644 index 000000000..7ac054791 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +strap.mikemcquaid.com diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 62df4965c..000000000 --- a/Dockerfile +++ /dev/null @@ -1,22 +0,0 @@ -ARG RUBY_VERSION=3 -FROM ruby:$RUBY_VERSION-alpine - -RUN apk --update add build-base - -RUN adduser strap --disabled-password --gecos "" -USER strap - -WORKDIR /app -COPY . . - -ENV RACK_ENV="production" \ - BUNDLE_DEPLOYMENT="1" \ - BUNDLE_WITHOUT="development" - -RUN script/bootstrap - -HEALTHCHECK --interval=5m --timeout=3s \ - CMD curl -f http://localhost:3000/ || exit 1 - -EXPOSE 3000 -ENTRYPOINT ["script/server"] diff --git a/Gemfile b/Gemfile index e568b21b0..908911430 100644 --- a/Gemfile +++ b/Gemfile @@ -1,18 +1,14 @@ -# frozen_string_literal: true - source "https://rubygems.org" ruby file: ".ruby-version" -gem "activesupport" -gem "faraday-retry" -gem "octokit" -gem "omniauth-github" -gem "puma" -gem "sinatra" +gem "github-pages", group: :jekyll_plugins group :development do - gem "guard" - gem "guard-process" - gem "rubocop" + gem "webrick" +end + +group :test do + gem "html-proofer" + gem "rake" end diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index 72b218982..000000000 --- a/Gemfile.lock +++ /dev/null @@ -1,169 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (7.2.1) - base64 - bigdecimal - concurrent-ruby (~> 1.0, >= 1.3.1) - connection_pool (>= 2.2.5) - drb - i18n (>= 1.6, < 2) - logger (>= 1.4.2) - minitest (>= 5.1) - securerandom (>= 0.3) - tzinfo (~> 2.0, >= 2.0.5) - addressable (2.8.7) - public_suffix (>= 2.0.2, < 7.0) - ast (2.4.2) - base64 (0.2.0) - bigdecimal (3.1.8) - coderay (1.1.3) - concurrent-ruby (1.3.4) - connection_pool (2.4.1) - drb (2.2.1) - faraday (2.11.0) - faraday-net_http (>= 2.0, < 3.4) - logger - faraday-net_http (3.3.0) - net-http - faraday-retry (2.2.1) - faraday (~> 2.0) - ffi (1.17.0) - formatador (1.1.0) - guard (2.18.1) - formatador (>= 0.2.4) - listen (>= 2.7, < 4.0) - lumberjack (>= 1.0.12, < 2.0) - nenv (~> 0.1) - notiffany (~> 0.0) - pry (>= 0.13.0) - shellany (~> 0.0) - thor (>= 0.18.1) - guard-compat (1.2.1) - guard-process (1.2.1) - guard-compat (~> 1.2, >= 1.2.1) - spoon (~> 0.0.1) - hashie (5.0.0) - i18n (1.14.5) - concurrent-ruby (~> 1.0) - json (2.7.2) - jwt (2.8.2) - base64 - language_server-protocol (3.17.0.3) - listen (3.9.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - logger (1.6.1) - lumberjack (1.2.10) - method_source (1.1.0) - minitest (5.25.1) - multi_xml (0.7.1) - bigdecimal (~> 3.1) - mustermann (3.0.3) - ruby2_keywords (~> 0.0.1) - nenv (0.3.0) - net-http (0.4.1) - uri - nio4r (2.7.3) - notiffany (0.1.3) - nenv (~> 0.1) - shellany (~> 0.0) - oauth2 (2.0.9) - faraday (>= 0.17.3, < 3.0) - jwt (>= 1.0, < 3.0) - multi_xml (~> 0.5) - rack (>= 1.2, < 4) - snaky_hash (~> 2.0) - version_gem (~> 1.1) - octokit (9.1.0) - faraday (>= 1, < 3) - sawyer (~> 0.9) - omniauth (2.1.2) - hashie (>= 3.4.6) - rack (>= 2.2.3) - rack-protection - omniauth-github (2.0.1) - omniauth (~> 2.0) - omniauth-oauth2 (~> 1.8) - omniauth-oauth2 (1.8.0) - oauth2 (>= 1.4, < 3) - omniauth (~> 2.0) - parallel (1.26.3) - parser (3.3.5.0) - ast (~> 2.4.1) - racc - pry (0.14.2) - coderay (~> 1.1) - method_source (~> 1.0) - public_suffix (6.0.1) - puma (6.4.2) - nio4r (~> 2.0) - racc (1.8.1) - rack (3.1.7) - rack-protection (4.0.0) - base64 (>= 0.1.0) - rack (>= 3.0.0, < 4) - rack-session (2.0.0) - rack (>= 3.0.0) - rainbow (3.1.1) - rb-fsevent (0.11.2) - rb-inotify (0.11.1) - ffi (~> 1.0) - regexp_parser (2.9.2) - rubocop (1.66.1) - json (~> 2.3) - language_server-protocol (>= 3.17.0) - parallel (~> 1.10) - parser (>= 3.3.0.2) - rainbow (>= 2.2.2, < 4.0) - regexp_parser (>= 2.4, < 3.0) - rubocop-ast (>= 1.32.2, < 2.0) - ruby-progressbar (~> 1.7) - unicode-display_width (>= 2.4.0, < 3.0) - rubocop-ast (1.32.3) - parser (>= 3.3.1.0) - ruby-progressbar (1.13.0) - ruby2_keywords (0.0.5) - sawyer (0.9.2) - addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) - securerandom (0.3.1) - shellany (0.0.1) - sinatra (4.0.0) - mustermann (~> 3.0) - rack (>= 3.0.0, < 4) - rack-protection (= 4.0.0) - rack-session (>= 2.0.0, < 3) - tilt (~> 2.0) - snaky_hash (2.0.1) - hashie - version_gem (~> 1.1, >= 1.1.1) - spoon (0.0.6) - ffi - thor (1.3.2) - tilt (2.4.0) - tzinfo (2.0.6) - concurrent-ruby (~> 1.0) - unicode-display_width (2.5.0) - uri (0.13.1) - version_gem (1.1.4) - -PLATFORMS - ruby - -DEPENDENCIES - activesupport - faraday-retry - guard - guard-process - octokit - omniauth-github - puma - rubocop - sinatra - -RUBY VERSION - ruby 3.3.4p94 - -BUNDLED WITH - 2.5.14 diff --git a/Guardfile b/Guardfile deleted file mode 100644 index 8ac6a5e95..000000000 --- a/Guardfile +++ /dev/null @@ -1,8 +0,0 @@ -# frozen_string_literal: true - -guard "process", name: "server", command: "script/server" do - watch "config.ru" - watch "Gemfile.lock" - watch "web/app.rb" - watch "web/puma.rb" -end diff --git a/LICENSE.txt b/LICENSE.txt index 7104b2dd4..dbbe35581 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,19 +1,661 @@ -Copyright (C) 2015 by Mike McQuaid - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index b8014ceaa..5ae2149d7 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,30 @@ -# Strap +# 👢 Strap -A script to bootstrap a minimal macOS development system. This does not assume you're doing Ruby/Rails/web development but installs the minimal set of software every macOS developer will want. +A script to bootstrap a minimal macOS development system with the minimal set of settings and software every macOS developer will want. ## Motivation -Replacing [Boxen](https://github.com/boxen/boxen) in [GitHub](https://github.com/) with a better tool. This post outlines the problems with Boxen and requirements for Strap and other tools used by GitHub: +Replacing [Boxen](https://github.com/boxen/boxen) in [GitHub](https://github.com/) with a better tool (see [mikemcquaid.com/replacing-boxen](https://mikemcquaid.com/replacing-boxen/)). + +## ☕️ Workbrew + +In 2023 I started a company, ☕️ Workbrew, to provide the missing features and support for companies using Homebrew. +Workbrew is now available in public beta and has a **Workbrew Bootstrap** feature that's basically Strap v2. +Additionally, Workbrew provides MDM integration, fleet configuration, remote `brew` command execution and much more. +Please [try it out](https://console.workbrew.com) or [book a demo](https://workbrew.com/demo). ## Features - Enables `sudo` using TouchID -- Disables Java in Safari (for better security) - Enables the macOS screensaver password immediately (for better security) - Enables the macOS application firewall (for better security) -- Adds a `Found this computer?` message to the login screen (for machine recovery) - Enables full-disk encryption and saves the FileVault Recovery Key to the Desktop (for better security) - Installs the Xcode Command Line Tools (for compilers and Unix tools) - Agree to the Xcode license (for using compilers without prompts) -- Installs [Homebrew](https://brew.sh) (for installing command-line software) -- Installs [Homebrew Bundle](https://github.com/Homebrew/homebrew-bundle) (for `bundler`-like `Brewfile` support) -- Installs [Homebrew Services](https://github.com/Homebrew/homebrew-services) (for managing Homebrew-installed services) -- Installs [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) (for installing graphical software) +- Installs [Homebrew](https://brew.sh) unless you already have [Workbrew](https://workbrew.com) installed (for installing software) - Installs the latest macOS software updates (for better security) -- Installs dotfiles from a user's `https://github.com/username/dotfiles` repository. If they exist and are executable: runs `script/setup` to configure the dotfiles and `script/strap-after-setup` after setting up everything else. -- Installs software from a user's `Brewfile` in their `https://github.com/username/homebrew-brewfile` repository or `.Brewfile` in their home directory. -- A simple web application to set Git's name, email and GitHub token (needs authorised on any organisations you wish to access) +- Updates dotfiles in a `~/.dotfiles` Git repository. If they exist and are executable: runs `script/setup` to configure the dotfiles and `script/strap-after-setup` after setting up everything else. +- Installs software from a user's `Brewfile` in their `~/.homebrew-brewfile` Git repository or `.Brewfile` in their home directory. - Idempotent ## Out of Scope Features @@ -32,51 +33,34 @@ Replacing [Boxen](https://github.com/boxen/boxen) in [GitHub](https://github.com - Installing Homebrew formulae by default for everyone in an organisation (install them with `Brewfile`s in project repositories instead of mandating formulae for the whole organisation) - Opting-out of any macOS updates (Apple's security updates and macOS updates are there for a reason) - Disabling security features (these are a minimal set of best practises) -- Add phone number to security screen message (want to avoid prompting users for information on installation) +- Most other things: Strap is now considered feature-complete ## Usage -Open in your web browser. +Open [strap.mikemcquaid.com](https://strap.mikemcquaid.com) in your web browser. Instead, to run Strap locally run: -```bash +```console git clone https://github.com/MikeMcQuaid/strap cd strap -bash bin/strap.sh # or bash bin/strap.sh --debug for more debugging output +bash strap.sh # or bash strap.sh --debug for more debugging output ``` Instead, to run the web application locally run: -```bash +```console git clone https://github.com/MikeMcQuaid/strap cd strap ./script/bootstrap -GITHUB_KEY="..." GITHUB_SECRET="..." ./script/server +./script/server ``` -Strap is also available as a Docker image on [Docker Hub (`mikemcquaid/strap`)](https://hub.docker.com/repository/docker/mikemcquaid/strap) and [GitHub Packages (`ghcr.io/mikemcquaid/strap`)](https://github.com/users/MikeMcQuaid/packages/container/package/strap). - -## Web Application Configuration Environment Variables - -- `GITHUB_KEY`: the GitHub.com Application Client ID. -- `GITHUB_SECRET`: the GitHub.com Application Client Secret. -- `SESSION_SECRET`: the secret used for cookie session storage. -- `WEB_CONCURRENCY`: the number of Puma (web server) threads to run (defaults to 3). -- `STRAP_ISSUES_URL`: the URL where users should file issues (defaults to no URL). -- `STRAP_BEFORE_INSTALL`: instructions displayed in the web application for users to follow before installing Strap (wrapped in `
  • ` tags). -- `CUSTOM_HOMEBREW_TAP`: an optional Homebrew tap to install with `brew tap`. Specify multiple arguments to brew tap by separating values with spaces. -- `CUSTOM_BREW_COMMAND`: a single `brew` command that is run after all other stages have completed. - ## Status -Stable and in active development. - -## Contact - -[Mike McQuaid](mailto:mike@mikemcquaid.com) +Feature complete. No further development planned. ## License -Licensed under the [MIT License](https://en.wikipedia.org/wiki/MIT_License). +Licensed under the [AGPLv3 License](https://en.wikipedia.org/wiki/Affero_General_Public_License). The full license text is available in [LICENSE.txt](https://github.com/MikeMcQuaid/strap/blob/main/LICENSE.txt). diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..be54e5207 --- /dev/null +++ b/_config.yml @@ -0,0 +1,41 @@ +title: 👢 Strap +description: A script to bootstrap a minimal macOS development system with the minimal set of settings and software every macOS developer will want. +url: https://strap.mikemcquaid.com + +author: + name: Mike McQuaid + email: mike@mikemcquaid.com + uri: https://mikemcquaid.com + twitter: MikeMcQuaid + +twitter: + username: MikeMcQuaid + card: summary + +social: + name: Mike McQuaid + links: + - https://github.com/MikeMcQuaid + - https://mastodon.social/@mikemcquaid + - https://www.linkedin.com/in/mkmcqd + - https://twitter.com/MikeMcQuaid + +permalink: "/:title/" + +exclude: + - bin + - CNAME + - Gemfile* + - LICENSE.txt + - Rakefile, + - README.md + - vendor + +plugins: + - jekyll-optional-front-matter + - jekyll-sitemap + - jekyll-seo-tag + - jekyll-titles-from-headings + +github: + repository_nwo: MikeMcQuaid/strap diff --git a/config.ru b/config.ru deleted file mode 100644 index aa3b5bf75..000000000 --- a/config.ru +++ /dev/null @@ -1,4 +0,0 @@ -# frozen_string_literal: true - -require "./web/app" -run Sinatra::Application diff --git a/index.html b/index.html new file mode 100644 index 000000000..843e833d9 --- /dev/null +++ b/index.html @@ -0,0 +1,78 @@ + + + + + + + + + + 👢 Strap + + + + + + +
    +

    + Strap is a script to bootstrap a minimal macOS development system with the minimal set of settings and software + every macOS developer will want. +

    + To Strap your system: +
      +
    1. + + Download the strap.sh script. + +
      2. + +
    2. + Run Strap in Terminal.app with bash ~/Downloads/strap.sh. +
      3. + +
    3. + If something failed, run Strap with more debugging output in + Terminal.app with bash ~/Downloads/strap.sh --debug and + try to debug it yourself, I can't help you, sorry! +
      4. + +
    4. + Install additional software with + brew install. +
      5. +
    +

    + In 2023 I started a company, ☕️ Workbrew, to provide the missing features and support for companies using + Homebrew. +
    + Workbrew is now available in public beta and has a Workbrew Bootstrap feature that's basically + Strap v2. +
    + Additionally, Workbrew provides MDM integration, fleet configuration, remote brew command execution + and much more. +
    + Please try it out or + book a demo. +

    +
    + +
    + + + Fork me on GitHub + + + + + + diff --git a/robots.txt b/robots.txt new file mode 100644 index 000000000..f0a7ed75c --- /dev/null +++ b/robots.txt @@ -0,0 +1,5 @@ +--- +--- +User-agent: * +Disallow: +Sitemap: {{ site.url }}/sitemap.xml diff --git a/script/bootstrap b/script/bootstrap index cad4cf00a..c87df6ebc 100755 --- a/script/bootstrap +++ b/script/bootstrap @@ -3,10 +3,6 @@ set -eu cd "$(dirname "$0")/.." -(command -v bundle >/dev/null 2>&1 && bundle -v >/dev/null 2>&1) || { - gem install bundler -} - bundle check >/dev/null 2>&1 || { bundle install } diff --git a/script/server b/script/server index a77a0ec0b..3de8a7f06 100755 --- a/script/server +++ b/script/server @@ -3,5 +3,4 @@ set -eu cd "$(dirname "$0")/.." -export PORT="${PORT:-3000}" -bundle exec puma --port "$PORT" --config web/puma.rb +bundle exec jekyll serve --watch --incremental --strict_front_matter diff --git a/script/style b/script/style index f1c076373..290b0e14d 100755 --- a/script/style +++ b/script/style @@ -17,7 +17,7 @@ sudo_askpass_style() { local violations violations=$( # find all sudo and filter out allowed calls - grep --line-number "[^'\"]sudo " bin/strap.sh | + grep --line-number "[^'\"]sudo " strap.sh | grep "${grep_regex_arg}" -v "^\d*: *#" | grep -v "pam_tid /etc/pam.d/sudo /etc/pam.d/sudo_local" | grep -v "sudo --reset-timestamp" | @@ -42,18 +42,6 @@ EOS fi } -ruby_version_style() { - local ruby_version - ruby_version="$(cat .ruby-version)" - - for file in "$@"; do - if ! git grep --quiet "ruby.${ruby_version}" HEAD -- "${file}"; then - echo "Error: ${file} does not contain 'ruby ${ruby_version}'!" >&2 - exit 1 - fi - done -} - shell_style() { local shfmt_args="--indent 2 --simplify --language-dialect=bash" @@ -73,20 +61,8 @@ shell_style() { shellcheck "$@" } -ruby_style() { - if [[ -n ${STYLE_FIX-} ]]; then - local rubocop_args="--autocorrect-all" - fi - - bundle exec rubocop --format quiet ${rubocop_args-} -} - script/bootstrap sudo_askpass_style -ruby_version_style Gemfile.lock - -shell_style bin/strap.sh script/* - -ruby_style +shell_style strap.sh script/* diff --git a/script/tests b/script/tests index 44e857d92..3a5142f46 100755 --- a/script/tests +++ b/script/tests @@ -3,23 +3,4 @@ set -xeuo pipefail cd "$(dirname "$0")/.." -export PUMA_PIDFILE="puma.pid" - -tests_cleanup() { - if [[ -n ${SERVER_PID-} ]]; then - kill "${SERVER_PID}" - fi -} - -trap "tests_cleanup" EXIT - -script/bootstrap -script/server & -sleep 5 - -SERVER_PID=$(cat "${PUMA_PIDFILE}") - -curl -O http://localhost:3000/strap.sh -curl -sSL -D - -o /dev/null http://localhost:3000/strap.sh | grep -i "x-frame-options: DENY" - -kill "$SERVER_PID" +bundle exec jekyll build --incremental --strict_front_matter diff --git a/bin/strap.sh b/strap.sh similarity index 58% rename from bin/strap.sh rename to strap.sh index 750e2c266..075dbb4db 100755 --- a/bin/strap.sh +++ b/strap.sh @@ -1,5 +1,5 @@ #!/bin/bash -#/ Usage: bin/strap.sh [--debug] +#/ Usage: strap.sh [--debug] #/ Install development dependencies on macOS. set -e @@ -26,8 +26,6 @@ cleanup() { fi if [ -z "$STRAP_DEBUG" ]; then echo "!!! Run '$0 --debug' for debugging output." >&2 - echo "!!! If you're stuck: file an issue with debugging output at:" >&2 - echo "!!! $STRAP_ISSUES_URL" >&2 fi fi } @@ -44,15 +42,6 @@ fi STDIN_FILE_DESCRIPTOR="0" [ -t "$STDIN_FILE_DESCRIPTOR" ] && STRAP_INTERACTIVE="1" -# Set by web/app.rb -# STRAP_GIT_NAME= -# STRAP_GIT_EMAIL= -# STRAP_GITHUB_USER= -# STRAP_GITHUB_TOKEN= -# CUSTOM_HOMEBREW_TAP= -# CUSTOM_BREW_COMMAND= -STRAP_ISSUES_URL='https://github.com/MikeMcQuaid/strap/issues/new' - # We want to always prompt for sudo password at least once rather than doing # root stuff unexpectedly. sudo --reset-timestamp @@ -168,6 +157,7 @@ run_dotfile_scripts() { else "$i" fi + logk break fi done @@ -213,24 +203,10 @@ fi # Set some basic security settings. logn "Configuring security settings:" -sudo_askpass defaults write com.apple.Safari \ - com.apple.Safari.ContentPageGroupIdentifier.WebKit2JavaEnabled \ - -bool false -sudo_askpass defaults write com.apple.Safari \ - com.apple.Safari.ContentPageGroupIdentifier.WebKit2JavaEnabledForLocalFiles \ - -bool false sudo_askpass defaults write com.apple.screensaver askForPassword -int 1 sudo_askpass defaults write com.apple.screensaver askForPasswordDelay -int 0 sudo_askpass defaults write /Library/Preferences/com.apple.alf globalstate -int 1 sudo_askpass launchctl load /System/Library/LaunchDaemons/com.apple.alf.agent.plist 2>/dev/null - -if [ -n "$STRAP_GIT_NAME" ] && [ -n "$STRAP_GIT_EMAIL" ]; then - LOGIN_TEXT=$(escape "Found this computer? Please contact $STRAP_GIT_NAME at $STRAP_GIT_EMAIL.") - echo "$LOGIN_TEXT" | grep -q '[()]' && LOGIN_TEXT="'$LOGIN_TEXT'" - sudo_askpass defaults write /Library/Preferences/com.apple.loginwindow \ - LoginwindowText \ - "$LOGIN_TEXT" -fi logk # Check and enable full-disk encryption. @@ -291,86 +267,54 @@ xcode_license() { } xcode_license -# Setup Git configuration. -logn "Configuring Git:" -if [ -n "$STRAP_GIT_NAME" ] && ! git config user.name >/dev/null; then - git config --global user.name "$STRAP_GIT_NAME" -fi - -if [ -n "$STRAP_GIT_EMAIL" ] && ! git config user.email >/dev/null; then - git config --global user.email "$STRAP_GIT_EMAIL" -fi - -if [ -n "$STRAP_GITHUB_USER" ] && [ "$(git config github.user)" != "$STRAP_GITHUB_USER" ]; then - git config --global github.user "$STRAP_GITHUB_USER" -fi - -# Squelch git 2.x warning message when pushing -if ! git config push.default >/dev/null; then - git config --global push.default simple -fi - -# Setup GitHub HTTPS credentials. -if git credential-osxkeychain 2>&1 | grep $Q "git.credential-osxkeychain"; then - # Actually execute the credential in case it's a wrapper script for credential-osxkeychain - if git "credential-$(git config --global credential.helper 2>/dev/null)" 2>&1 | - grep -v $Q "git.credential-osxkeychain"; then - git config --global credential.helper osxkeychain +logn "Installing Homebrew:" +if [[ ! -f "/opt/workbrew/bin/brew" ]]; then + # Setup Homebrew directory and permissions. + HOMEBREW_PREFIX="$(brew --prefix 2>/dev/null || true)" + HOMEBREW_REPOSITORY="$(brew --repository 2>/dev/null || true)" + if [ -z "$HOMEBREW_PREFIX" ] || [ -z "$HOMEBREW_REPOSITORY" ]; then + UNAME_MACHINE="$(/usr/bin/uname -m)" + if [[ $UNAME_MACHINE == "arm64" ]]; then + HOMEBREW_PREFIX="/opt/homebrew" + HOMEBREW_REPOSITORY="${HOMEBREW_PREFIX}" + else + HOMEBREW_PREFIX="/usr/local" + HOMEBREW_REPOSITORY="${HOMEBREW_PREFIX}/Homebrew" + fi fi - - if [ -n "$STRAP_GITHUB_USER" ] && [ -n "$STRAP_GITHUB_TOKEN" ]; then - printf 'protocol=https\nhost=github.com\n' | git credential reject - printf 'protocol=https\nhost=github.com\nusername=%s\npassword=%s\n' \ - "$STRAP_GITHUB_USER" "$STRAP_GITHUB_TOKEN" | - git credential approve + [ -d "$HOMEBREW_PREFIX" ] || sudo_askpass mkdir -p "$HOMEBREW_PREFIX" + if [ "$HOMEBREW_PREFIX" = "/usr/local" ]; then + sudo_askpass chown "root:wheel" "$HOMEBREW_PREFIX" 2>/dev/null || true fi -fi -logk + ( + cd "$HOMEBREW_PREFIX" + sudo_askpass mkdir -p Cellar Caskroom Frameworks bin etc include lib opt sbin share var + sudo_askpass chown "$USER:admin" Cellar Caskroom Frameworks bin etc include lib opt sbin share var + ) -# Setup Homebrew directory and permissions. -logn "Installing Homebrew:" -HOMEBREW_PREFIX="$(brew --prefix 2>/dev/null || true)" -HOMEBREW_REPOSITORY="$(brew --repository 2>/dev/null || true)" -if [ -z "$HOMEBREW_PREFIX" ] || [ -z "$HOMEBREW_REPOSITORY" ]; then - UNAME_MACHINE="$(/usr/bin/uname -m)" - if [[ $UNAME_MACHINE == "arm64" ]]; then - HOMEBREW_PREFIX="/opt/homebrew" - HOMEBREW_REPOSITORY="${HOMEBREW_PREFIX}" - else - HOMEBREW_PREFIX="/usr/local" - HOMEBREW_REPOSITORY="${HOMEBREW_PREFIX}/Homebrew" - fi -fi -[ -d "$HOMEBREW_PREFIX" ] || sudo_askpass mkdir -p "$HOMEBREW_PREFIX" -if [ "$HOMEBREW_PREFIX" = "/usr/local" ]; then - sudo_askpass chown "root:wheel" "$HOMEBREW_PREFIX" 2>/dev/null || true -fi -( - cd "$HOMEBREW_PREFIX" - sudo_askpass mkdir -p Cellar Caskroom Frameworks bin etc include lib opt sbin share var - sudo_askpass chown "$USER:admin" Cellar Caskroom Frameworks bin etc include lib opt sbin share var -) + [ -d "$HOMEBREW_REPOSITORY" ] || sudo_askpass mkdir -p "$HOMEBREW_REPOSITORY" + sudo_askpass chown -R "$USER:admin" "$HOMEBREW_REPOSITORY" -[ -d "$HOMEBREW_REPOSITORY" ] || sudo_askpass mkdir -p "$HOMEBREW_REPOSITORY" -sudo_askpass chown -R "$USER:admin" "$HOMEBREW_REPOSITORY" + if [ $HOMEBREW_PREFIX != $HOMEBREW_REPOSITORY ]; then + ln -sf "$HOMEBREW_REPOSITORY/bin/brew" "$HOMEBREW_PREFIX/bin/brew" + fi -if [ $HOMEBREW_PREFIX != $HOMEBREW_REPOSITORY ]; then - ln -sf "$HOMEBREW_REPOSITORY/bin/brew" "$HOMEBREW_PREFIX/bin/brew" + # Download Homebrew. + export GIT_DIR="$HOMEBREW_REPOSITORY/.git" GIT_WORK_TREE="$HOMEBREW_REPOSITORY" + git init $Q + git config remote.origin.url "https://github.com/Homebrew/brew" + git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" + git fetch $Q --tags --force + git reset $Q --hard origin/master + unset GIT_DIR GIT_WORK_TREE + logk +else + logskip "Workbrew is already installed so not trying to install Homebrew." fi -# Download Homebrew. -export GIT_DIR="$HOMEBREW_REPOSITORY/.git" GIT_WORK_TREE="$HOMEBREW_REPOSITORY" -git init $Q -git config remote.origin.url "https://github.com/Homebrew/brew" -git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" -git fetch $Q --tags --force -git reset $Q --hard origin/master -unset GIT_DIR GIT_WORK_TREE -logk - # Update Homebrew. export PATH="$HOMEBREW_PREFIX/bin:$PATH" -logn "Updating Homebrew:" +log "Updating Homebrew:" brew update --quiet logk @@ -391,70 +335,34 @@ else fi # Setup dotfiles -if [ -n "$STRAP_GITHUB_USER" ]; then - DOTFILES_URL="https://github.com/$STRAP_GITHUB_USER/dotfiles" - - if git ls-remote "$DOTFILES_URL" &>/dev/null; then - log "Fetching $STRAP_GITHUB_USER/dotfiles from GitHub:" - if [ ! -d "$HOME/.dotfiles" ]; then - log "Cloning to ~/.dotfiles:" - git clone $Q "$DOTFILES_URL" ~/.dotfiles - else - ( - cd ~/.dotfiles - git pull $Q --rebase --autostash - ) - fi - run_dotfile_scripts script/setup script/bootstrap - logk - fi +if [ -d "$HOME/.dotfiles/.git" ]; then + logn "Updating ~/.dotfiles:" + ( + cd ~/.dotfiles + git pull $Q --rebase --autostash + ) + logk + run_dotfile_scripts script/setup script/bootstrap fi # Setup Brewfile -if [ -n "$STRAP_GITHUB_USER" ] && { [ ! -f "$HOME/.Brewfile" ] || [ "$HOME/.Brewfile" -ef "$HOME/.homebrew-brewfile/Brewfile" ]; }; then - HOMEBREW_BREWFILE_URL="https://github.com/$STRAP_GITHUB_USER/homebrew-brewfile" - - if git ls-remote "$HOMEBREW_BREWFILE_URL" &>/dev/null; then - log "Fetching $STRAP_GITHUB_USER/homebrew-brewfile from GitHub:" - if [ ! -d "$HOME/.homebrew-brewfile" ]; then - log "Cloning to ~/.homebrew-brewfile:" - git clone $Q "$HOMEBREW_BREWFILE_URL" ~/.homebrew-brewfile - logk - else - ( - cd ~/.homebrew-brewfile - git pull $Q - ) - fi - ln -sf ~/.homebrew-brewfile/Brewfile ~/.Brewfile - logk - fi +if [ -d "$HOME/.homebrew-brewfile/.git" ]; then + log "Updating ~/.homebrew-brewfile:" + ( + cd ~/.homebrew-brewfile + git pull $Q + ) + ln -sf ~/.homebrew-brewfile/Brewfile ~/.Brewfile + logk fi # Install from local Brewfile if [ -f "$HOME/.Brewfile" ]; then - log "Installing from user Brewfile on GitHub:" + log "Installing from ~/.Brewfile:" brew bundle check --global &>/dev/null || brew bundle --global logk fi -# Tap a custom Homebrew tap -if [ -n "$CUSTOM_HOMEBREW_TAP" ]; then - read -ra CUSTOM_HOMEBREW_TAP <<<"$CUSTOM_HOMEBREW_TAP" - log "Running 'brew tap ${CUSTOM_HOMEBREW_TAP[*]}':" - brew tap "${CUSTOM_HOMEBREW_TAP[@]}" - logk -fi - -# Run a custom `brew` command -if [ -n "$CUSTOM_BREW_COMMAND" ]; then - log "Executing 'brew $CUSTOM_BREW_COMMAND':" - # Want to expand even if empty or multiple arguments - # shellcheck disable=SC2086 - brew $CUSTOM_BREW_COMMAND - logk -fi - # Run post-install dotfiles script run_dotfile_scripts script/strap-after-setup diff --git a/web/app.rb b/web/app.rb deleted file mode 100644 index f86c9ce96..000000000 --- a/web/app.rb +++ /dev/null @@ -1,189 +0,0 @@ -# frozen_string_literal: true - -require "sinatra" -require "omniauth-github" -require "octokit" -require "rack/protection" -require "active_support/core_ext/object/blank" - -# Don't worry: these credentials are not sensitive but just use for -# "Strap (development)" with the URL and callback both set to localhost. -GITHUB_KEY = ENV.fetch("GITHUB_KEY", "b28d0c47b8925e999e49") -GITHUB_SECRET = ENV.fetch("GITHUB_SECRET", "037ac891e2e0b8bc91558d5ff358d2ff4fa1beb7") - -SESSION_SECRET = ENV.fetch("SESSION_SECRET") -STRAP_ISSUES_URL = ENV.fetch("STRAP_ISSUES_URL", nil) -STRAP_BEFORE_INSTALL = ENV.fetch("STRAP_BEFORE_INSTALL", nil) -CUSTOM_HOMEBREW_TAP = ENV.fetch("CUSTOM_HOMEBREW_TAP", nil) -CUSTOM_BREW_COMMAND = ENV.fetch("CUSTOM_BREW_COMMAND", nil) -OMNIAUTH_FULL_HOST = ENV.fetch("OMNIAUTH_FULL_HOST", nil) -RACK_ENV = ENV.fetch("RACK_ENV", nil) - -# In some configurations, the full host may need to be set to something other -# than the canonical URL. -if OMNIAUTH_FULL_HOST - OmniAuth.config.full_host = OMNIAUTH_FULL_HOST - - # For some reason this needs to be a no-op when using OMNIAUTH_FULL_HOST - OmniAuth.config.request_validation_phase = nil -end - -set :sessions, secret: SESSION_SECRET - -use OmniAuth::Builder do - options = { - # access is given for gh cli, packages, git client setup and repo checkouts - scope: "user:email, repo, workflow, write:packages, read:packages, read:org, read:discussions", - allow_signup: false, - } - options[:provider_ignores_state] = true if RACK_ENV == "development" - provider :github, GITHUB_KEY, GITHUB_SECRET, options -end - -use Rack::Protection, use: %i[authenticity_token cookie_tossing form_token - remote_referrer strict_transport] - -get "/auth/github/callback" do - auth = request.env["omniauth.auth"] - - session[:auth] = { - "info" => auth["info"], - "credentials" => auth["credentials"], - } - - redirect to "/" -end - -get "/" do - before_install_list_item = "
  • #{STRAP_BEFORE_INSTALL}
    • " if STRAP_BEFORE_INSTALL - - debugging_text = if STRAP_ISSUES_URL.blank? - "try to debug it yourself" - else - %(file an issue at #{STRAP_ISSUES_URL}) - end - - download_button_text = "Download the strap.sh script" - - if session[:auth].present? - login_step = "You authorized Strap on GitHub ✅" - download_button_or_text = <<~HTML - - #{download_button_text} - - HTML - view_link_text = "view it in your browser" - else - csrf = request.env["rack.session"]["csrf"] - login_step = <<~HTML -
    - - - which will prompt for access to your email, public and private - repositories; you'll need to provide access to any organizations whose - repositories you need to be able to git clone. This is - used to add a GitHub access token to the strap.sh script - and is not otherwise used by this web application or stored - anywhere. -
    - HTML - download_button_or_text = download_button_text - view_link_text = "view the uncustomised version in your browser" - end - - @title = "👢 Strap" - @text = <<~HTML - To Strap your system: -
      - #{before_install_list_item} - -
    1. - #{login_step} -
      2. - -
    2. - #{download_button_or_text} - that's been customised for your GitHub user (or - - #{view_link_text} - - first). -
      3. - -
    3. - Run Strap in Terminal.app with bash ~/Downloads/strap.sh. -
      4. - -
    4. - If something failed, run Strap with more debugging output in - Terminal.app with bash ~/Downloads/strap.sh --debug and - #{debugging_text}. -
      5. - -
    5. - Delete the customised strap.sh (it has a GitHub token - in it) in Terminal.app with - rm -f ~/Downloads/strap.sh -
      6. - -
    6. - Install additional software with - brew install. -
      7. -
    - HTML - erb :root -end - -get "/strap.sh" do - auth = session[:auth] - - script = File.expand_path("#{File.dirname(__FILE__)}/../bin/strap.sh") - content = File.read(script) - - set_variables = { STRAP_ISSUES_URL: STRAP_ISSUES_URL } - unset_variables = {} - - unset_variables[:CUSTOM_HOMEBREW_TAP] = CUSTOM_HOMEBREW_TAP if CUSTOM_HOMEBREW_TAP - - unset_variables[:CUSTOM_BREW_COMMAND] = CUSTOM_BREW_COMMAND if CUSTOM_BREW_COMMAND - - if auth - unset_variables.merge! STRAP_GIT_NAME: auth["info"]["name"], - STRAP_GIT_EMAIL: auth["info"]["email"], - STRAP_GITHUB_USER: auth["info"]["nickname"], - STRAP_GITHUB_TOKEN: auth["credentials"]["token"] - end - - env_sub(content, set_variables, set: true) - env_sub(content, unset_variables, set: false) - - # Manually set X-Frame-Options because Rack::Protection won't set it on - # non-HTML files: - # https://github.com/sinatra/sinatra/blob/v2.0.7/rack-protection/lib/rack/protection/frame_options.rb#L32 - headers["X-Frame-Options"] = "DENY" - content_type = if params["text"] - "text/plain" - else - "application/octet-stream" - end - erb content, content_type: content_type -end - -private - -def env_sub(content, variables, set:) - variables.each do |key, value| - next if value.blank? - - regex = if set - /^#{key}='.*'$/ - else - /^# #{key}=$/ - end - escaped_value = value.gsub("'", "\\\\\\\\'") - content.gsub!(regex, "#{key}='#{escaped_value}'") - end -end diff --git a/web/puma.rb b/web/puma.rb deleted file mode 100644 index f3be60b2c..000000000 --- a/web/puma.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -# Puma can serve each request in a thread from an internal thread pool. -# The `threads` method setting takes two numbers: a minimum and maximum. -# Any libraries that use thread pools should be configured to match -# the maximum value specified for Puma. -max_threads_count = ENV.fetch("WEB_CONCURRENCY", 3) -min_threads_count = ENV.fetch("WEB_CONCURRENCY") { max_threads_count } -threads min_threads_count, max_threads_count - -# Specifies the `worker_timeout` threshold that Puma will use to wait before -# terminating a worker in development environments. -worker_timeout 3600 if ENV.fetch("RACK_ENV", "development") == "development" - -# Specifies the `port` that Puma will listen on to receive requests; default is 3000. -port ENV.fetch("PORT", 3000) - -# Specifies the `environment` that Puma will run in. -environment ENV.fetch("RACK_ENV", "development") - -# Optionally specifies the `pidfile` that Puma will use. -if (puma_pidfile = ENV.fetch("PUMA_PIDFILE", nil)) - pidfile puma_pidfile -end - -# needed to avoid multiple workers from having different session secrets -require "securerandom" -ENV["SESSION_SECRET"] = SecureRandom.hex(64) unless ENV["SESSION_SECRET"] diff --git a/web/views/root.erb b/web/views/root.erb deleted file mode 100644 index 751d4d26a..000000000 --- a/web/views/root.erb +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - <%= @title %> - - - -
    -

    - Strap is a script to bootstrap a minimal macOS development system. - This does not assume you're doing Ruby/Rails/web development but installs the minimal set of software every macOS developer will want. -

    - <%= @text %> -

    - If you like Strap, you'll love - - ☕️ Workbrew - . -

    -

    - In 2023 I started a company, Workbrew, to provide the missing features and support for companies using Homebrew. -
    - Workbrew is now available in private beta. -
    - It provides MDM integration, fleet configuration and remote brew command execution. -
    - All our customers get hands-on bespoke support from the longest-running Homebrew maintainer (me, - Mike McQuaid!). -
    - Please get in touch or - book a demo. -

    -
    - - <%# Spacer to avoid bottom navbar overlapping. %> -
    - - - Fork me on GitHub - - - - -