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

FUSE documentation should indicate that the /ipfs and /ipns directories do not show user files #7738

Open
lonerzzz opened this issue Oct 27, 2020 · 5 comments
Labels
need/triage Needs initial labeling and prioritization topic/docs-ipfs Topic docs-ipfs topic/fuse Topic fuse

Comments

@lonerzzz
Copy link

Location

https://github.com/ipfs/go-ipfs/blob/master/docs/fuse.md

Probably other locations as well.

Description

The documentation about FUSE and mounting is missing a key detail in that it does not communicate the intent of the mounted file systems. More information is included at https://github.com/ipfs/go-ipfs/blob/master/docs/fuse.md and https://discuss.ipfs.io/t/fuse-mountpoint-mini-faq/312, but a person has to do a lot of searching before they find it.

For someone seeking a distributed file system, the intended usage of the /ipfs and /ipns directories is not communicated at all. I would expect a mounted file system to allow me to see the distributed files with the names of the files as they were added to the file system, not as internal file components. I would expect to be able read, write and list files that were added to the file system.

The /ipfs and /ipns are not for this purpose at all, resulting in considerable time spent to ultimately learn that the description of a FUSE file system is only technically correct but nowhere near what would be understood by an outsider or as seen in documentation such as https://en.wikipedia.org/wiki/Comparison_of_distributed_file_systems

I did not find any documentation to communicate this basic fact.

@lonerzzz lonerzzz added need/triage Needs initial labeling and prioritization topic/docs-ipfs Topic docs-ipfs labels Oct 27, 2020
@welcome
Copy link

welcome bot commented Oct 27, 2020

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 additional 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.

@jacobheun jacobheun added the topic/fuse Topic fuse label Oct 30, 2020
@aschmahmann
Copy link
Contributor

@lonerzzz it sounds like you're looking for a mount for MFS and not for IPFS/IPNS. We could add an FAQ section to the page with some info about there not being an MFS mount.

Note: The FUSE implementation itself could also use some love, it seems likely that adding MFS support would come when we get to do an overhaul of the mount implementation itself.

@lonerzzz
Copy link
Author

Adding to the FAQ section would be helpful, as would a brief explanation on this page (https://github.com/ipfs/go-ipfs/blob/master/docs/fuse.md) for clarification. Ultimately, the most widely applicable use of a distributed file system is in allowing replication of files so any overhaul of the mount implementation that enables this would increase adoption of the solution.

@Erudition
Copy link

Same problem - just went through all that work to get /ipfs mount working so I could use my file explorer app to manage files... turns out it stays empty, and any folder name longer than one character is "too long".

@pirate
Copy link

pirate commented Feb 19, 2023

😿 we ran into the same problem over here too: #7922

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/triage Needs initial labeling and prioritization topic/docs-ipfs Topic docs-ipfs topic/fuse Topic fuse
Projects
None yet
Development

No branches or pull requests

5 participants