ParetoSecurity / pareto-mac

Automatically audit your Mac for basic security hygiene.
https://paretosecurity.com
GNU General Public License v3.0
326 stars 24 forks source link

Please create a Homebrew manuscript. #127

Open ivaquero opened 2 years ago

ivaquero commented 2 years ago

Homebrew is widely used Package Manager for macOS. Many macOS applications provide with Homebrew installation.

Could you please create a PR for Homebrew Cask?

zupo commented 2 years ago

Hey @ivaquero!

I haven't used Homebrew for a while (am using Nix these days) and my memory is a bit off, but isn't Homebrew meant more for CLI tools, and not for UI desktop apps? What kind of a use case are you trying to solve?

ivaquero commented 2 years ago

Yes, Homebrew Core is for CLI, while Homebrew Cask is for GUI applications.

I would like to manage ParetoSecurity uniformly with one package manager (Homebrew, though Nix is cooler).

Homebrew Cask manifest is easy to create, however, I am not familiar with where ParetoSecurity store information (location required to fill in "zap" block of the manifest.)

zupo commented 2 years ago

Hey @ivaquero, I couldn't find anyone on the current list of contributors that is willing to support this, so I'm closing this issue. If you wanna champion it, and support it in the future, I'd be very happy to review a Pull Request to add support!

ivaquero commented 2 years ago

No problem. I will create a PR when I got time this week.

AlexanderWillner commented 2 years ago

+1 ;)

fharper commented 2 years ago

@ivaquero: were you able to create the PR?

zupo commented 2 years ago

I'm reopening because there seems to be interest.

ivaquero commented 2 years ago

@ivaquero: were you able to create the PR?

Sure, brew cask manifests are easy to write. But just like what I mentioned in the previous comment, it's hard for me to find the ZAP paths of this application which are required by homebrew official.

I show my draft below, I use it personally. Please help to complete the ZAP section.

  version "1.7.36"
  sha256 "b212b1e03fcc6953c04b272f4bad435935d3dc9df24a49720308db070ea03193"

  url "https://github.com/ParetoSecurity/pareto-mac/releases/download/#{version}/ParetoSecurity.dmg",
      verified:   "github.com/ParetoSecurity/",
      user_agent: :fake
  name "Pareto Security"
  desc "Automatically audit your computer for basic security hygiene"
  homepage "https://paretosecurity.com/"

  livecheck do
    url :url
    strategy :github_latest
  end

  depends_on macos: ">= :sierra"
  app "Pareto Security.app"

  zap trash: [
    path needed: such as generated files in 
    /Library/Preferences, 
    /Library/Logs, 
    /Library/Saved application State
  ]

end
mjpieters commented 1 year ago

Note that Homebrew will only accept PRs for apps that have a certain level of popularity (checked for automatically but see their exceptions checklist).

It's easy to create your own homebrew tap, which is essentially just a GitHub repo with formulae. There's a naming convention; if you name the repo homebrew-cask then brew install ParetoSecurity/cask/ParetoSecurity will find the Casks/ParetoSecurity.rb cask in that repository. Or name it homebrew-tap and have Formula and Casks subdirectories; probably the better choice if there are cli tools in the pipeline.