Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kubo install: update Mac instructions #1655

Merged
merged 6 commits into from
Aug 11, 2023
Merged

Conversation

ElPaisano
Copy link
Contributor

Addresses #1602

@ElPaisano ElPaisano linked an issue Aug 7, 2023 that may be closed by this pull request
@ElPaisano ElPaisano marked this pull request as ready for review August 7, 2023 00:09
@ElPaisano ElPaisano requested a review from lidel August 7, 2023 00:09
@ElPaisano
Copy link
Contributor Author

@lidel this PR updates Kubo install instructions for Mac to recommend https://formulae.brew.sh/formula/ipfs over the current mac install process which uses curl https://docs.ipfs.tech/install/command-line/#install-official-binary-distributions

Could you or someone from the kubo team do a quick review of the updated instructions? https://bafybeiczcyidxtimhmot5rgfhfsrxayt2tas6y6mkcp4c7n5ti3c3kal3q.on.fleek.co/install/command-line/#install-official-binary-distributions

One thing I'm wondering: would there be any reason to keep the old mac install instructions somewhere in the docs? Or can we just cut them completely and suggest brew?

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, sounds sensible, with big caveat below + small suggestion inline.

On macOS notarization and who do we trust

I am not macOS user myself, but my understanding of macOS security is that it is based on reputation of the entity that builds artifact and performs macOS notarization.

If you do something shady, your notarization key is revoked, and all apps that were notarized with it are revoked from running as well.

This PR replaces dist.ipfs.tech artifacts notarized using Protocol Labs keys and infrastructure, with brew package that follows this formula which builds artifacts on their own infrastructure and then publishes binaries at https://ghcr.io URLs visible in https://formulae.brew.sh/api/formula/ipfs.json. I imagine at the end of the build but before publishing, the artifacts are notarized somehow with Brew keys?

Should we trust and endorse brew?

So the question is: do we trust Brew CI and Github less that we trust Github CI (already used for building dist.ipfs.tech) and our own self-hosting at dist.ipfs.tech?

To me, it does not sound like we weaken supply chain security for macOS much, if anything, there are more eyes looking at Brew notarized artifacts than currently looking at dist.ipfs.tech. Pointing at brew may be net positive, as it provides users with a mechanism for getting future updates via brew CLI.

Once again, I am not macOS user, would be good to get 👍 from someone more familiar with Kubo and brew
(cc @hacdias @alanshaw @olizilla ?)

docs/install/command-line.md Outdated Show resolved Hide resolved
docs/install/command-line.md Outdated Show resolved Hide resolved
@hacdias
Copy link
Member

hacdias commented Aug 10, 2023

I personally do think we should list Homebrew. I use it quite a lot on macOS and I even used to have Kubo installed via brew. I no longer do it simply because I work on its codebase, so I just need to make install. But if I had to recommend someone with macOS, I would definitely just point them at brew.

Co-authored-by: Marcin Rataj <lidel@lidel.org>
Copy link
Contributor Author

@ElPaisano ElPaisano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor writing things

docs/install/command-line.md Outdated Show resolved Hide resolved
docs/install/command-line.md Outdated Show resolved Hide resolved
@ElPaisano ElPaisano merged commit c5b7983 into main Aug 11, 2023
5 checks passed
@ElPaisano ElPaisano deleted the update/install/command-line branch August 11, 2023 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Kubo Install - can we just recommend folks on mac to use homebrew?
3 participants