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

Documentation for the usage of the outbound network connections #138

Open
6 tasks
shadeofblue opened this issue Nov 8, 2022 · 3 comments
Open
6 tasks

Comments

@shadeofblue
Copy link
Contributor

shadeofblue commented Nov 8, 2022

This task aims to prepare an initial version of a handbook article containing information about outbound network usage. It should assume that the reader doesn't know much about the outbound network per se (what does it exactly mean, where would I need this feature etc), but is already familiar with the requestor/provider model and has the essential tools (like yagna daemon) installed and running.

The article should cover the following topics:

  • What is the outbound network and when would a user need it
  • How golem approaches outbound network connections (with whitelists and manifests, not mentioning CA for now)
  • How to prepare a manifest
  • How to launch a service based on a manifest directly through yapapi
  • How to prepare a dApp descriptor which uses a manifest definition
  • How to verify if the outbound network is working correctly

The article about signing the manifests with CA should be covered separately, as it won't be as common practice as the outbound network usage itself

currently available documentation: https://handbook.golem.network/requestor-tutorials/service-development/service-example-6-external-api-request

The article should be prepared either as:

@golemfactory golemfactory deleted a comment from VanDavv Jan 16, 2023
@golemfactory golemfactory deleted a comment from shadeofblue Jan 16, 2023
@lucekdudek lucekdudek changed the title documentation for the usage of the outbound network connections Documentation for the usage of the outbound network connections Jan 19, 2023
@shadeofblue shadeofblue removed their assignment Jan 23, 2023
@approxit
Copy link

We need to prepare specific place for docs mentioned in this issue.

@approxit
Copy link

@VanDavv declared to scan handbook for outbound-related docs.
Also, instead of creating specific place in docs, we could just prepare the content in SDK's team notion.

@VanDavv VanDavv removed their assignment Jan 27, 2023
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

No branches or pull requests

3 participants