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

docs: add guide on how to run nwaku from a droplet #1130

Closed
4 tasks done
jm-clius opened this issue Sep 8, 2022 · 0 comments · Fixed by #1133
Closed
4 tasks done

docs: add guide on how to run nwaku from a droplet #1130

jm-clius opened this issue Sep 8, 2022 · 0 comments · Fixed by #1133
Assignees
Labels
track:operator-outreach Operator outreach track (Secure Messaging/Waku Product)

Comments

@jm-clius
Copy link
Contributor

jm-clius commented Sep 8, 2022

Background

This issue relates to #828 and forms part of #1003.

Although the operator guide goes some way to explain to operators how to set up and dimension their own nwaku nodes, we still lack step-by-step tutorials for specific run/computing environments. A community member unfamiliar with cloud computing platforms, for example, may want to know how they can configure a long-term running nwaku instance without having access to their own hardware. Someone else may want to get instructions for running nwaku on a Raspberry Pi. Note that the idea is not to promote a specific set of hardware or a specific cloud computing provider, but simply to make the operator guide as accessible as possible with example configurations.

Since many developers already use Digital Ocean droplets, a good first step would be to add a how-to guide for getting nwaku to run a droplet.

Acceptance criteria

Simple how-to guide with:

  • quickstart on how to spin up a droplet of sufficient size (no need to repeat Digital Ocean tutorials here - could just mention most obvious steps and link to DO docs for more advanced configuration)
  • script to copy nwaku binary to Droplet
  • script to run nwaku on this Droplet with at least default configuration (relay + store) + domain name configured + DNS discovery enabled (could link to other how-to page) + discv5 enabled
  • how to verify that it is indeed running

Monitoring instructions, more advanced deployment configuration, Grafana dashboards etc. can be included in a subsequent PR.

Research track

This forms part of the operator-outreach track.

@jm-clius jm-clius added track:operator-outreach Operator outreach track (Secure Messaging/Waku Product) track:maintenance labels Sep 8, 2022
@rymnc rymnc moved this to Done in Vac Research Sep 13, 2022
@jm-clius jm-clius moved this to Done in Waku Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
track:operator-outreach Operator outreach track (Secure Messaging/Waku Product)
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants