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

Remove the package manager section from the "Command-line install" page. #589

Closed
swedneck opened this issue Jan 7, 2021 · 8 comments · Fixed by #674
Closed

Remove the package manager section from the "Command-line install" page. #589

swedneck opened this issue Jan 7, 2021 · 8 comments · Fixed by #674
Assignees
Labels
dif/trivial Can be confidently tackled by newcomers effort/hours Estimated to take one or several hours kind/maintenance Work required to avoid breaking changes or harm to project's status quo P2 Medium: Good to have, but can wait until someone steps up status/in-progress In progress topic/docs Documentation

Comments

@swedneck
Copy link

swedneck commented Jan 7, 2021

I feel that snap just causes more strangeness than is worth, and can really confuse people when they don't find stuff where they expect it (e.g. ~/.ipfs), and it can make helping the people using it more difficult.
I would suggest acknowleding that the snap package exists but not recommend it as THE way to install it on ubuntu.

It's also somewhat strange to only list chocolatey, homebrew, and snap, but that's a separate issue..

@swedneck swedneck added the need/triage Needs initial labeling and prioritization label Jan 7, 2021
@welcome
Copy link

welcome bot commented Jan 7, 2021

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

@johnnymatthews johnnymatthews added kind/discussion Topical discussion; usually not changes to codebase topic/docs Documentation and removed need/triage Needs initial labeling and prioritization labels Jan 11, 2021
@johnnymatthews
Copy link
Contributor

The purpose of including the package manager install options is to reduce the time and effort it takes to install IPFS. A lot of readers use these one-liners to quickly install IPFS, without much configuration.

Snap is included because it comes pre-installed with Ubuntu, and it's a pretty simple way to install IPFS. While Chocolatey and Homebrew don't come pre-installed on their respective operating systems, they are the de-facto package managers for those OSes.

@lidel
Copy link
Member

lidel commented Jan 14, 2021

@swedneck which docs you suggest changing/adjusting?
https://docs.ipfs.io/install/ipfs-desktop/#ubuntu suggests using .deb for Ubuntu (not .snap).

That being said, on top of what @johnnymatthews said, the downside is that .deb installed manually won't get autoupdates and people will be stuck at old versions. Snap users get updates for free, so perhaps we should suggest that instead, as long we solve ~/.ipfs problem?

Two ideas/questions:

  • Perhaps we should have additional version check running for platforms without autoupdate mechanism and display OS notification or something?
  • What is the location of ~/.ipfs in Snap, if not in user's home? Sounds like something we could fix, perhaps we are building .snap without some flag?

@ardunster
Copy link
Contributor

I am not familiar with how IPFS is packaged, but as a Ubuntu user I'd try to install it through apt if at all possible rather than snap. Had too many weird issues with how snap handles things and don't want to deal with it. apt is at least as common, if not more so than snap, especially if people are running older LTSs.

@johnnymatthews
Copy link
Contributor

... as a Ubuntu user I'd try to install it through apt ... - @ardunster

As far as I know, the apt repository isn't as frequently maintained when compared to the snap package. Is this true @lidel, or am I making this up?

@lidel
Copy link
Member

lidel commented Feb 24, 2021

@johnnymatthews you are most likely right: apt is just a tool, it uses repo set up by distribution. Debian and Ubuntu use apt, but point at different repositories.

Given that snap is published by our CI (ipfs/kubo#7529), and it is up to distribution maintainers/community to update the .deb package in apt repo to the latest version, snap will always be updated sooner than apt package.

That being said, I don't like nor use snaps myself, and just like @ardunster prefer native package manager like apt, then fallback using official Docker image.

We should promote those even more than we do with Snap, because are useful for more distributions + Snap introduces this distracting yellow warning on https://docs.ipfs.io/install/command-line/#package-managers 🙈

For now I've filled #660 to add Docker, which was missing 😅

@johnnymatthews
Copy link
Contributor

Ok cool, thanks for clearing that up @lidel. It seems like the general sentiment is to get rid of Snap since it causes more problems than it fixes, and the alternative apt isn't too far out of date to be a major issue. I'll take Snap out :)

For now I've filled #660 to add Docker, which was missing - @lidel

Perfect! Thanks for that.

@johnnymatthews johnnymatthews self-assigned this Feb 24, 2021
@johnnymatthews johnnymatthews added dif/trivial Can be confidently tackled by newcomers effort/hours Estimated to take one or several hours kind/maintenance Work required to avoid breaking changes or harm to project's status quo P2 Medium: Good to have, but can wait until someone steps up status/in-progress In progress and removed kind/discussion Topical discussion; usually not changes to codebase labels Feb 24, 2021
@johnnymatthews johnnymatthews changed the title Reconsider suggesting snap installs Remove Snap from the Install section. Feb 24, 2021
@johnnymatthews
Copy link
Contributor

Hmm, we've got a tiny problem. IPFS isn't listed in any of the apt repos. With that in mind, I'm inclined to take the Package Manager section out of here. Chocolately and Homebrew aren't installed by default, Snap causes problems, and Apt doesn't contain IPFS packages. So all-in-all, none of these solutions are on-liners, which was the intention for this section. There are installation instructions for each OS under the Official distributions section, so we've got our bases covered there.

@johnnymatthews johnnymatthews added this to the Week 08 (2021) milestone Feb 24, 2021
@johnnymatthews johnnymatthews changed the title Remove Snap from the Install section. Removes the package manager section from the "Command-line install" page. Mar 2, 2021
@johnnymatthews johnnymatthews changed the title Removes the package manager section from the "Command-line install" page. Remove the package manager section from the "Command-line install" page. Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/trivial Can be confidently tackled by newcomers effort/hours Estimated to take one or several hours kind/maintenance Work required to avoid breaking changes or harm to project's status quo P2 Medium: Good to have, but can wait until someone steps up status/in-progress In progress topic/docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants