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.

Sign up for GitHub

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

Jump to bottom

Update docs to reflect Relay V1 (server) removal from go-ipfs #1146

Closed
lidel opened this issue May 13, 2022 · 7 comments
Closed

Update docs to reflect Relay V1 (server) removal from go-ipfs #1146

lidel opened this issue May 13, 2022 · 7 comments
Assignees
@TheDiscordian
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week kind/bug A bug in existing code (including security flaws) kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/triage Needs initial labeling and prioritization

Comments

@lidel
Copy link
Member

lidel commented May 13, 2022

We need to update all places that mention EnableRelayHop – Relay V1 server was removed from go-ipfs 0.11 and now requires running a separate binary.

See details in:

The most important is to update "browsers connectivity" tutorial by @TheDiscordian:

  1. https://blog.ipfs.io/2021-06-10-guide-to-ipfs-connectivity-in-browsers/
  2. https://docs.ipfs.io/how-to/create-simple-chat-app/

(We seem to already document v1 and v2 in https://docs.ipfs.io/concepts/nodes/#types)
@lidel lidel added dif/hard Having worked on the specific codebase is important P1 High: Likely tackled by core team if no one steps up kind/bug A bug in existing code (including security flaws) kind/maintenance Work required to avoid breaking changes or harm to project's status quo effort/days Estimated to take multiple days, but less than a week labels May 13, 2022
@lidel
Copy link
Member Author

lidel commented May 13, 2022

@TheDiscordian as you are the original author of the tutorial, would you have time to update it?
My next 2-3 weeks are pretty packed, and I won't be able to do this any time soon.

@lidel lidel added this to the Best Effort Track milestone May 13, 2022
@lidel lidel moved this to 🥞 Todo in IPFS Shipyard Team May 13, 2022
@lidel lidel mentioned this issue May 16, 2022
Closed
@TheDiscordian
Copy link
Member

TheDiscordian commented May 16, 2022 •
edited
Loading

@lidel I'd love to, I plan to have this updated by Friday. (Edit: Though could be as late as next Wednesday)

@johnnymatthews johnnymatthews moved this to Backlog in Protocol Docs May 17, 2022
@TheDiscordian TheDiscordian mentioned this issue May 18, 2022
Merged
@TheDiscordian TheDiscordian mentioned this issue May 26, 2022
Merged
lidel pushed a commit that referenced this issue May 27, 2022
@TheDiscordian @johnnymatthews
Create Simple Chat App Update (#1161)
f15a206 
* Updated diagram, changed links to be up-to-date, removed Docker section, added warning about circuit-relay v1 removal from go-ipfs & linked to a repo with most of the code needed to use the chat app /w a relay (but missing pubsub & the ability to list addrs, so no announcing) towards  #1146

* Fixes minor typo.

Co-authored-by: Johnny <[email protected]>
@lidel
Copy link
Member Author

lidel commented May 28, 2022 •
edited
Loading

@TheDiscordian this is probably a bad question to ask at 2AM, but since all peers use the same webrtc signaling server, and they can post their own multiaddr to the same pubsub channel, why do we need the Python script for advertising on pubsub on their behalf? I feel i am missing something.

@TheDiscordian
Copy link
Member

@lidel I missed this until now, the reason for the pubsub is for the relay connections (IE: Cannot punch for WebRTC). Node A connects to Relay, Relay advertises Node A, Node B connects to Relay, Relay advertises Node B, Node A now has a path to Node B, connecting them together via Relay.

@ElPaisano ElPaisano removed this from the Best Effort Track milestone Jan 26, 2023
@ElPaisano
Copy link
Contributor

@BigLep @lidel can you help Johnny and I determine if this is still relevant?

From https://docs.ipfs.tech/concepts/nodes/#relay, it looks like we still mention relay v1

@ElPaisano ElPaisano added need/triage Needs initial labeling and prioritization and removed P1 High: Likely tackled by core team if no one steps up labels Mar 29, 2023
@ElPaisano
Copy link
Contributor

Removing the P1 label, as the team doesn't seem to be pressing this issue. Will keep in backlog until I hear back.

@ElPaisano
Copy link
Contributor

Since https://docs.ipfs.io/how-to/create-simple-chat-app/ has been removed as part of the js-ipfs cleanup, this is no longer relevant. Closing.

@github-project-automation github-project-automation bot moved this from 🥞 Todo to 🎉 Done in IPFS Shipyard Team Aug 21, 2023
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Protocol Docs Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TheDiscordian TheDiscordian

Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week kind/bug A bug in existing code (including security flaws) kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/triage Needs initial labeling and prioritization
Projects
No open projects
IPFS Shipyard Team
Archived in project
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lidel @TheDiscordian @ElPaisano