Update documentation

assets/js/20987266.4d20d509.js

@@ -0,0 +1 @@
+(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[7442],{53958:(e,o,n)=>{"use strict";var t=n(83639);n.o(t,"AccordionItem")&&n.d(o,{AccordionItem:function(){return t.AccordionItem}})},26820:(e,o,n)=>{"use strict";n.r(o),n.d(o,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>u,toc:()=>c});var t=n(87462),a=(n(67294),n(3905)),i=n(53958);const r={title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},d=void 0,u={unversionedId:"guides/nwaku/faq",id:"guides/nwaku/faq",title:"Nwaku FAQ",description:"Check out the Run Nwaku with Docker Compose guide to learn the simplest and fastest way to run a node. You can also check the comprehensive Run a Nwaku Node guide to explore other options like downloading binaries and building from source.",source:"@site/docs/guides/nwaku/faq.md",sourceDirName:"guides/nwaku",slug:"/guides/nwaku/faq",permalink:"/guides/nwaku/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/nwaku/faq.md",tags:[],version:"current",lastUpdatedAt:1709637863,formattedLastUpdatedAt:"5 Mar 2024",frontMatter:{title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"guides",previous:{title:"Node Configuration Examples",permalink:"/guides/nwaku/configure-nwaku"},next:{title:"Upgrade Instructions",permalink:"/guides/nwaku/upgrade-instructions"}},s={},c=[],k={toc:c},g="wrapper";function h(e){let{components:o,...n}=e;return(0,a.kt)(g,(0,t.Z)({},k,n,{components:o,mdxType:"MDXLayout"}),(0,a.kt)(i.AccordionItem,{title:"How can I run a Waku node?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/run-docker-compose"},"Run Nwaku with Docker Compose")," guide to learn the simplest and fastest way to run a node. You can also check the comprehensive ",(0,a.kt)("a",{href:"/guides/nwaku/run-node"},"Run a Nwaku Node")," guide to explore other options like ",(0,a.kt)("a",{href:"/guides/nwaku/run-node#download-the-binary"},"downloading binaries")," and ",(0,a.kt)("a",{href:"/guides/nwaku/build-source"},"building from source"),"."),(0,a.kt)(i.AccordionItem,{title:"What are the system requirements for running a node?",mdxType:"AccordionItem"},"We recommend running a nwaku node with at least 2GB of RAM, especially if WSS is enabled. If running just a Relay node, 0.5GB of RAM is sufficient."),(0,a.kt)(i.AccordionItem,{title:"How can I interact with my running nwaku node?",mdxType:"AccordionItem"},"You can interact with a running nwaku node using the ",(0,a.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/"},"REST API interface")," or the ",(0,a.kt)("a",{href:"/guides/js-waku/"},"JavaScript Waku SDK"),"."),(0,a.kt)(i.AccordionItem,{title:"How can I view the logs of a nwaku node running in Docker?",mdxType:"AccordionItem"},'To check your node logs in Docker, use the command: "docker-compose logs -f nwaku"'),(0,a.kt)(i.AccordionItem,{title:"What configuration methods are available for nwaku nodes?",mdxType:"AccordionItem"},"You can configure Nwaku nodes using command line options and flags, environment variables, and TOML configuration files. Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/config-methods"},"Node Configuration Methods")," guide to understand their usage and priority."),(0,a.kt)(i.AccordionItem,{title:"How can I configure my nwaku node before running?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/config-options"},"Node Configuration Options")," guide for available node configuration options, their default values and descriptions. For examples of common configuration use cases, visit the ",(0,a.kt)("a",{href:"/guides/nwaku/configure-nwaku"},"Node Configuration Examples")," guide."),(0,a.kt)(i.AccordionItem,{title:"What peer discovery mechanisms are available for nwaku nodes, and how can I configure them?",mdxType:"AccordionItem"},"You can configure peer discovery for nwaku nodes through options like ",(0,a.kt)("a",{href:"/learn/concepts/static-peers"},"Static Peers"),", ",(0,a.kt)("a",{href:"/learn/concepts/dns-discovery"},"DNS Discovery"),", ",(0,a.kt)("a",{href:"/learn/concepts/discv5"},"DiscV5"),", and ",(0,a.kt)("a",{href:"/learn/concepts/peer-exchange"},"Peer Exchange"),". Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/configure-discovery"},"Configure Peer Discovery")," guide for setting up your node."),(0,a.kt)(i.AccordionItem,{title:"How do I find my nwaku node's addresses for peer discovery?",mdxType:"AccordionItem"},"The node listening and ENR addresses can be found through the node's logs and ",(0,a.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info"},"REST API"),". Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/run-node#find-the-node-addresses"},"Find the node addresses")," section to understand how to locate your node addresses."))}h.isMDXComponent=!0},46102:()=>{}}]);

assets/js/20987266.5ff7d2d6.js

@@ -1 +0,0 @@
-(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[7442],{53958:(e,o,n)=>{"use strict";var t=n(83639);n.o(t,"AccordionItem")&&n.d(o,{AccordionItem:function(){return t.AccordionItem}})},26820:(e,o,n)=>{"use strict";n.r(o),n.d(o,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>u,toc:()=>c});var t=n(87462),a=(n(67294),n(3905)),i=n(53958);const r={title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},d=void 0,u={unversionedId:"guides/nwaku/faq",id:"guides/nwaku/faq",title:"Nwaku FAQ",description:"Check out the Run Nwaku with Docker Compose guide to learn the simplest and fastest way to run a node. You can also check the comprehensive Run a Nwaku Node guide to explore other options like downloading binaries and building from source.",source:"@site/docs/guides/nwaku/faq.md",sourceDirName:"guides/nwaku",slug:"/guides/nwaku/faq",permalink:"/guides/nwaku/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/nwaku/faq.md",tags:[],version:"current",lastUpdatedAt:1709637863,formattedLastUpdatedAt:"5 Mar 2024",frontMatter:{title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"guides",previous:{title:"Node Configuration Examples",permalink:"/guides/nwaku/configure-nwaku"},next:{title:"JavaScript Waku SDK",permalink:"/guides/js-waku/"}},s={},c=[],k={toc:c},g="wrapper";function h(e){let{components:o,...n}=e;return(0,a.kt)(g,(0,t.Z)({},k,n,{components:o,mdxType:"MDXLayout"}),(0,a.kt)(i.AccordionItem,{title:"How can I run a Waku node?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/run-docker-compose"},"Run Nwaku with Docker Compose")," guide to learn the simplest and fastest way to run a node. You can also check the comprehensive ",(0,a.kt)("a",{href:"/guides/nwaku/run-node"},"Run a Nwaku Node")," guide to explore other options like ",(0,a.kt)("a",{href:"/guides/nwaku/run-node#download-the-binary"},"downloading binaries")," and ",(0,a.kt)("a",{href:"/guides/nwaku/build-source"},"building from source"),"."),(0,a.kt)(i.AccordionItem,{title:"What are the system requirements for running a node?",mdxType:"AccordionItem"},"We recommend running a nwaku node with at least 2GB of RAM, especially if WSS is enabled. If running just a Relay node, 0.5GB of RAM is sufficient."),(0,a.kt)(i.AccordionItem,{title:"How can I interact with my running nwaku node?",mdxType:"AccordionItem"},"You can interact with a running nwaku node using the ",(0,a.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/"},"REST API interface")," or the ",(0,a.kt)("a",{href:"/guides/js-waku/"},"JavaScript Waku SDK"),"."),(0,a.kt)(i.AccordionItem,{title:"How can I view the logs of a nwaku node running in Docker?",mdxType:"AccordionItem"},'To check your node logs in Docker, use the command: "docker-compose logs -f nwaku"'),(0,a.kt)(i.AccordionItem,{title:"What configuration methods are available for nwaku nodes?",mdxType:"AccordionItem"},"You can configure Nwaku nodes using command line options and flags, environment variables, and TOML configuration files. Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/config-methods"},"Node Configuration Methods")," guide to understand their usage and priority."),(0,a.kt)(i.AccordionItem,{title:"How can I configure my nwaku node before running?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/config-options"},"Node Configuration Options")," guide for available node configuration options, their default values and descriptions. For examples of common configuration use cases, visit the ",(0,a.kt)("a",{href:"/guides/nwaku/configure-nwaku"},"Node Configuration Examples")," guide."),(0,a.kt)(i.AccordionItem,{title:"What peer discovery mechanisms are available for nwaku nodes, and how can I configure them?",mdxType:"AccordionItem"},"You can configure peer discovery for nwaku nodes through options like ",(0,a.kt)("a",{href:"/learn/concepts/static-peers"},"Static Peers"),", ",(0,a.kt)("a",{href:"/learn/concepts/dns-discovery"},"DNS Discovery"),", ",(0,a.kt)("a",{href:"/learn/concepts/discv5"},"DiscV5"),", and ",(0,a.kt)("a",{href:"/learn/concepts/peer-exchange"},"Peer Exchange"),". Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/configure-discovery"},"Configure Peer Discovery")," guide for setting up your node."),(0,a.kt)(i.AccordionItem,{title:"How do I find my nwaku node's addresses for peer discovery?",mdxType:"AccordionItem"},"The node listening and ENR addresses can be found through the node's logs and ",(0,a.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info"},"REST API"),". Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/run-node#find-the-node-addresses"},"Find the node addresses")," section to understand how to locate your node addresses."))}h.isMDXComponent=!0},46102:()=>{}}]);

assets/js/d3c3b3be.07fdb66c.js

@@ -0,0 +1 @@
+(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[8824],{53958:(e,t,n)=>{"use strict";var i=n(83639);n.o(i,"AccordionItem")&&n.d(t,{AccordionItem:function(){return i.AccordionItem}})},46442:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>g,frontMatter:()=>a,metadata:()=>u,toc:()=>l});var i=n(87462),r=(n(67294),n(3905)),o=n(53958);const a={title:"Upgrade Instructions",hide_table_of_contents:!0,sidebar_label:"Upgrade Instructions"},s=void 0,u={unversionedId:"guides/nwaku/upgrade-instructions",id:"guides/nwaku/upgrade-instructions",title:"Upgrade Instructions",description:"If you are currently using Nwaku, running an old version and want to upgrade your node, please follow the below migration instructions for each target release newer than your current running version in ascending order.",source:"@site/docs/guides/nwaku/upgrade-instructions.md",sourceDirName:"guides/nwaku",slug:"/guides/nwaku/upgrade-instructions",permalink:"/guides/nwaku/upgrade-instructions",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/nwaku/upgrade-instructions.md",tags:[],version:"current",lastUpdatedAt:1726478944,formattedLastUpdatedAt:"16 Sept 2024",frontMatter:{title:"Upgrade Instructions",hide_table_of_contents:!0,sidebar_label:"Upgrade Instructions"},sidebar:"guides",previous:{title:"Frequently Asked Questions",permalink:"/guides/nwaku/faq"},next:{title:"JavaScript Waku SDK",permalink:"/guides/js-waku/"}},d={},l=[{value:"Target Releases",id:"target-releases",level:2}],c={toc:l},p="wrapper";function g(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,"If you are currently using Nwaku, running an old version and want to upgrade your node, please follow the below migration instructions for each target release newer than your current running version in ascending order."),(0,r.kt)("p",null,"For example, if you are interested in the version v0.32.0 and are currently running v0.30.0, follow the instructions for v0.31.0 and then the ones for v0.32.0"),(0,r.kt)("h2",{id:"target-releases"},"Target Releases"),(0,r.kt)(o.AccordionItem,{title:"v0.32.0",mdxType:"AccordionItem"},(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"--protected-topic")," CLI config was deprecated and is replaced by the new ",(0,r.kt)("inlineCode",{parentName:"p"},"--protected-shard")," configuration. Instead of configuring ",(0,r.kt)("inlineCode",{parentName:"p"},"topic:public_key")," you will now need to configure ",(0,r.kt)("inlineCode",{parentName:"p"},"shard:public_key"),(0,r.kt)("br",null),(0,r.kt)("br",null)),(0,r.kt)("p",null,"For example, if you used to run your node with ",(0,r.kt)("inlineCode",{parentName:"p"},'--protected-topic="waku/2/rs/3/4:your_public_key"')," you will need to replace this configuration for ",(0,r.kt)("inlineCode",{parentName:"p"},'--protected-shard="4:your_public_key"'))),(0,r.kt)(o.AccordionItem,{title:"v0.31.0",mdxType:"AccordionItem"},"Named sharding was deprecated in this version. This means that pubsub topics will only be supported if they comply with the static sharding format: ",(0,r.kt)("code",null,"/waku/2/rs/<CLUSTER_ID>/<SHARD_ID>"),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("p",null,"In order to migrate your existing application, you need to:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},"Make sure that your clients are sending messages to pubsub topics in the required format. Check that in your interactions with Nwaku's REST API or when using ",(0,r.kt)("inlineCode",{parentName:"li"},"js-waku"),", the configured pubsub topics follow the static sharding format defined above."),(0,r.kt)("li",{parentName:"ol"},"When running a node with the ",(0,r.kt)("inlineCode",{parentName:"li"},"--pubsub-topic")," CLI flag, the values provided should comply with the static sharding format."),(0,r.kt)("li",{parentName:"ol"},"If your application relies on nodes or clients that may not be updated immediately, keep your node on an older version while subscribing to both the current pubsub topic and the new pubsub topic that will comply with the static sharding format. In that case, you can keep backward compatibility for a migration period."))))}g.isMDXComponent=!0},46102:()=>{}}]);

build.json

@@ -1,15 +1,15 @@
 {
-    "timestamp": "2024-09-11T05:45:08Z",
+    "timestamp": "2024-09-16T09:31:11Z",
     "git": {
-        "commit": "583a4105b6d50af897dbcb9f89f633c165eedb5d",
+        "commit": "8ca783537b367379821b4a4ed39eb4f905d80e3a",
         "branch": "origin/develop",
         "url": "git@github.com:waku-org/docs.waku.org.git"
     },
     "build": {
-        "id": "155",
-        "number": "155",
+        "id": "156",
+        "number": "156",
         "name": "website/dev-docs.waku.org",
         "slave": "linux-02",
-        "url": "https://ci.infra.status.im/job/website/job/dev-docs.waku.org/155/"
+        "url": "https://ci.infra.status.im/job/website/job/dev-docs.waku.org/156/"
     }
 }