Skip to content

Add a note about Snap confinement#605

Merged
johnnymatthews merged 6 commits intoipfs:mainfrom
gammazero:patch-1
Feb 9, 2021
Merged

Add a note about Snap confinement#605
johnnymatthews merged 6 commits intoipfs:mainfrom
gammazero:patch-1

Conversation

@gammazero
Copy link
Copy Markdown
Contributor

Users who want to know how to install IPFS may not be aware of Snap's confinement behavior. So, I thought it useful to add a note someplace where they might see it before they install the Ubuntu Snap package.

Hopefully, this can prevent issues like this one: ipfs/kubo#7872

Users who want to know how to install IPFS may not be aware of Snap's [confinement](https://snapcraft.io/docs/snap-confinement) behavior.  So, I thought it useful to add a note someplace where they might see it before they install the Ubuntu Snap package.

Hopefully, this can prevent issues like this one: ipfs/kubo#7872
@welcome
Copy link
Copy Markdown

welcome Bot commented Jan 22, 2021

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@aschmahmann
Copy link
Copy Markdown
Contributor

cc @olizilla, does this sound good to you?

Copy link
Copy Markdown
Member

@olizilla olizilla left a comment

Choose a reason for hiding this comment

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

Yes indeed! Good idea to warn about it. I would use a ::: callout or similar to highlight it, and move it to directly below the table.

@johnnymatthews
Copy link
Copy Markdown
Contributor

Moved the warning into a :::warning box. Saying that, if installing things through Snap without the --classic flag is gonna cause issues, should we just advise folks to use the --classic flag all the time?

@aschmahmann
Copy link
Copy Markdown
Contributor

@gammazero I'm not sure this is actually enough. Since the snap has strict in the config.yaml users get Warning: flag --classic ignored for strictly confined snap ipfs.

We should probably just change to telling people to use --classic (and changing our config.yaml). We could potentially give access to more plugs as well (perhaps, system-files).

@johnnymatthews
Copy link
Copy Markdown
Contributor

Updated the instructions to use --classic by default.

changing our config.yaml - @aschmahmann

What's required for this?

@olizilla
Copy link
Copy Markdown
Member

olizilla commented Feb 2, 2021

The snap default is strict confinement. The ipfs snap has always had strict confinement. Are lots of folks getting suprised by that? The installing user can add and get files via an ipfs daemon installed by snap, so I'm not clear on what the problem is.

Snap is not other package managers, and we should be careful around our assumptions of how things should work. We should definitely review the list plugs and add any that are missing tho. I am mildly against reducing the confinment at this point unless i am missing some context.

@johnnymatthews
Copy link
Copy Markdown
Contributor

Right. In that case, I'm not sure what to do here then. Installing IPFS with Snap is easy to set up and for most folks to use, but comes with confinement complications. I'd like to keep a simple one-liner here for Ubuntu users though.

@olizilla
Copy link
Copy Markdown
Member

olizilla commented Feb 8, 2021

The best thing would be to caveat it in the docs for now, similar to the orginal PR, and open an issue on go-ipfs to review the snap.yml config to make it as un-annoying as possible, given that snaps defaults are much stricter than other package managers.

johnnymatthews and others added 3 commits February 8, 2021 12:08
Provide a bit more explanation for snap:
1. An explanation that Snap has container permissions + link
2. Say that it gives permissions to `/home`
3. Link that describes how to grant access to
@johnnymatthews johnnymatthews merged commit 0d08331 into ipfs:main Feb 9, 2021
@gammazero gammazero deleted the patch-1 branch February 17, 2021 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants