docs.waku.org/assets/js/7c28fd94.bcb64bc0.js

1 line
12 KiB
JavaScript
Raw Normal View History

2025-08-13 03:24:27 +00:00
"use strict";(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[9830],{24033:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"guides/nwaku/run-docker-compose","title":"Run Nwaku with Docker Compose","description":"nwaku-compose is a ready-to-use Docker Compose setup that configures the following automatically:","source":"@site/docs/guides/nwaku/run-docker-compose.md","sourceDirName":"guides/nwaku","slug":"/guides/nwaku/run-docker-compose","permalink":"/guides/nwaku/run-docker-compose","draft":false,"unlisted":false,"editUrl":"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/nwaku/run-docker-compose.md","tags":[],"version":"current","lastUpdatedAt":null,"frontMatter":{"title":"Run Nwaku with Docker Compose","hide_table_of_contents":true},"sidebar":"guides","previous":{"title":"Run a Nwaku Node","permalink":"/guides/nwaku/run-node"},"next":{"title":"Run Nwaku in a Docker Container","permalink":"/guides/nwaku/run-docker"}}');var t=o(74848),r=o(28453);const i={title:"Run Nwaku with Docker Compose",hide_table_of_contents:!0},a=void 0,c={},d=[{value:"Video tutorial",id:"video-tutorial",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"Clone the repository",id:"clone-the-repository",level:2},{value:"Configure the setup",id:"configure-the-setup",level:2},{value:"Register for RLN membership",id:"register-for-rln-membership",level:2},{value:"Run the node",id:"run-the-node",level:2},{value:"Monitor the node",id:"monitor-the-node",level:2},{value:"Interact with the node",id:"interact-with-the-node",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://github.com/waku-org/nwaku-compose",children:"nwaku-compose"})," is a ready-to-use Docker Compose setup that configures the following automatically:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"nwaku"})," node running ",(0,t.jsx)(n.a,{href:"/learn/concepts/protocols#relay",children:"Relay"})," and ",(0,t.jsx)(n.a,{href:"/learn/concepts/protocols#store",children:"Store"})," protocols with ",(0,t.jsx)(n.a,{href:"/learn/concepts/protocols#rln-relay",children:"RLN"})," enabled."]}),"\n",(0,t.jsx)(n.li,{children:"Simple frontend to interact with the node and Waku network to send and receive messages."}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://grafana.com/",children:"Grafana"})," metrics dashboard for advanced users and node operators to monitor the node."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"video-tutorial",children:"Video tutorial"}),"\n",(0,t.jsx)("div",{class:"video-container",children:(0,t.jsx)("iframe",{class:"yt-video",src:"https://www.youtube.com/embed/fs0ynLk4z0I",title:"How to run a Waku node using Nwaku Compose",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:!0})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["Check out the ",(0,t.jsx)(n.a,{target:"_blank","data-noBrokenLinkCheck":!0,href:o(96343).A+"",children:"Waku Node Operator Cheatsheet"})," to learn how to easily run, monitor, and interact with a node."]})}),"\n",(0,t.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://git-scm.com/",children:"Git"})," or ",(0,t.jsx)(n.a,{href:"https://desktop.github.com/",children:"GitHub Desktop"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker"})," and ",(0,t.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"})]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-ch