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

Update readme to clarify how links can be opened #1366

Closed
ghost opened this issue Feb 29, 2020 · 2 comments · Fixed by #1426
Closed

Update readme to clarify how links can be opened #1366

ghost opened this issue Feb 29, 2020 · 2 comments · Fixed by #1426
Labels
effort/hours Estimated to take one or several hours exp/beginner Can be confidently tackled by newcomers exp/novice Someone with a little familiarity can pick up good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/design-content Content design, writing, information architecture

Comments

@ghost
Copy link

ghost commented Feb 29, 2020

The readme mentions

"Handle ipfs://, ipns:// and dweb: links

If you come across a link to any of the protocols above, IPFS Desktop will be able to open them and redirect them to your default browser."

but it is missing, both from here as from ipfs guides (https://docs.ipfs.io/guides), how should one proceed to open an ipfs link that is provided as text. This is a very basic feature and I fear that if I'm having this much trouble, this could scare a lot of users from further digging into ipfs. If I have an ipfs link, say, /ipns/torrent-paradise.ml, how should I proceed to open it using the ipfs-desktop application or the background daemon?

Edit: with the frontend, I'm of course able to visualize the files from a web application, but how can I open the link directly in the browser as a website? I know I could do it through cloudfare or https://ipfs.io/LINK, but these are just centralized proxy services to the actual descentralized network, so it is important to be able to open the links in the browser with some 127.0.0.1/ipfs/obj syntax. This is missing from documentation though.

Edit2: I kept randomly messing with the port numbers until I found the correct one: 8080. So, in the example given, http://127.0.0.1:8080/ipns/<something> typed into the browser will show the website. Although I figured it out by sheer luck, I still think it is very important to have this info in the readme. 8080 is a common port providing a "localhost" alternative for the 80 http default, but in no way should be taken as a given.

@lidel
Copy link
Member

lidel commented Mar 9, 2020

If I have an ipfs link, say, /ipns/torrent-paradise.ml, how should I proceed to open it using the ipfs-desktop application or the background daemon?

You can just prefix any content path with some gateway, eg. https://ipfs.io/ and it should load.

If you install ipfs-companion browser extension it will redirect such requests to local gateway at http://127.0.0.1:8080

Although I figured it out by sheer luck, I still think it is very important to have this info in the readme. 8080 is a common port providing a "localhost" alternative for the 80 http default, but in no way should be taken as a given.

Agree. Do you want to open a PR that updates README and adds expected info?

@lidel lidel added exp/novice Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue UX labels Mar 9, 2020
@hacdias
Copy link
Member

hacdias commented Mar 26, 2020

When we say "handle ipfs://, ipns:// and dweb: links" it means exactly that: links with those protocols can be handled by IPFS Desktop, i.e., they can be opened by IPFS Desktop.

For example, if you come across to a link that points to 'ipns://ipfs.io', it will be opened by IPFS Desktop. Internally, IPFS Desktop will translate that into a Gateway URL (https://ipfs.io/ipns/ipfs.io in this case) and open your browser.

@jessicaschilling jessicaschilling added topic/design-content Content design, writing, information architecture topic/design-ux UX strategy, research, not solely visual design and removed UX labels Mar 30, 2020
@jessicaschilling jessicaschilling changed the title HOW to open an ipfs link? Update readme to clarify how links can be opened Apr 8, 2020
@jessicaschilling jessicaschilling added exp/beginner Can be confidently tackled by newcomers effort/hours Estimated to take one or several hours good first issue Good issue for new contributors kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked and removed topic/design-ux UX strategy, research, not solely visual design labels Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/hours Estimated to take one or several hours exp/beginner Can be confidently tackled by newcomers exp/novice Someone with a little familiarity can pick up good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/design-content Content design, writing, information architecture
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants