mirror of
https://github.com/logos-messaging/docs.waku.org.git
synced 2026-01-04 05:43:07 +00:00
updates from Marina
This commit is contained in:
parent
57453e47d1
commit
5c969c54b8
@ -16,7 +16,7 @@ graph LR
|
|||||||
W -->|Message 3| R2(Message Receiver 2)
|
W -->|Message 3| R2(Message Receiver 2)
|
||||||
```
|
```
|
||||||
|
|
||||||
<iframe class="yt-video" src="https://www.youtube.com/embed/PYQaXCxUCwA" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
<iframe class="yt-video" src="https://www.youtube.com/embed/nIWx5Vp_Qxk" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
Check out our [Learn section](/learn/waku-network), [YouTube channel](https://www.youtube.com/@wakuorg), and [Blog](https://blog.waku.org/) to dive into how Waku works behind the scenes!
|
Check out our [Learn section](/learn/waku-network), [YouTube channel](https://www.youtube.com/@wakuorg), and [Blog](https://blog.waku.org/) to dive into how Waku works behind the scenes!
|
||||||
@ -43,7 +43,11 @@ Check out our [Learn section](/learn/waku-network), [YouTube channel](https://ww
|
|||||||
Looking for what to build with Waku? Discover a collection of sample ideas and use cases for inspiration, curated by our community at: https://ideas.waku.org/ and [Awesome Waku](https://github.com/waku-org/awesome-waku/).
|
Looking for what to build with Waku? Discover a collection of sample ideas and use cases for inspiration, curated by our community at: https://ideas.waku.org/ and [Awesome Waku](https://github.com/waku-org/awesome-waku/).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Run a Waku node
|
## Use cases
|
||||||
|
|
||||||
|
## Get started
|
||||||
|
|
||||||
|
### Run a Waku node
|
||||||
|
|
||||||
Waku is a decentralised, permissionless system where anyone can run a node, use the network, and contribute to its support. We recommend following the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide and [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to easily run a node.
|
Waku is a decentralised, permissionless system where anyone can run a node, use the network, and contribute to its support. We recommend following the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide and [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to easily run a node.
|
||||||
|
|
||||||
@ -53,7 +57,7 @@ Waku is a decentralised, permissionless system where anyone can run a node, use
|
|||||||
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Integrate using SDKs
|
### Integrate using SDKs
|
||||||
|
|
||||||
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
|
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
|
||||||
|
|
||||||
@ -62,7 +66,7 @@ Waku is implemented in multiple SDKs, allowing it to integrate with different la
|
|||||||
| [@waku/sdk](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | [JavaScript Waku SDK](/guides/js-waku/) |
|
| [@waku/sdk](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | [JavaScript Waku SDK](/guides/js-waku/) |
|
||||||
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `@waku/sdk` | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) |
|
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `@waku/sdk` | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) |
|
||||||
|
|
||||||
## Other integrations
|
### Other integrations
|
||||||
|
|
||||||
| | Description | Documentation |
|
| | Description | Documentation |
|
||||||
| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
|
|||||||
@ -117,6 +117,10 @@ curl --location 'http://127.0.0.1:8645/store/v1/messages?contentTopics=%2Fmy-app
|
|||||||
--header 'Accept: application/json'
|
--header 'Accept: application/json'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||||
|
:::
|
||||||
|
|
||||||
:::tip Congratulations!
|
:::tip Congratulations!
|
||||||
You have successfully started a `nwaku` node with `RLN` enabled using Docker Compose. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) and [Advanced Configuration](https://github.com/waku-org/nwaku-compose/blob/master/ADVANCED.md) guides to learn how to configure `nwaku` for different use cases.
|
You have successfully started a `nwaku` node with `RLN` enabled using Docker Compose. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) and [Advanced Configuration](https://github.com/waku-org/nwaku-compose/blob/master/ADVANCED.md) guides to learn how to configure `nwaku` for different use cases.
|
||||||
:::
|
:::
|
||||||
|
|||||||
@ -56,10 +56,14 @@ To find your public IP, use:
|
|||||||
dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
|
dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
|
||||||
```
|
```
|
||||||
|
|
||||||
:::tip
|
:::info
|
||||||
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
|
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||||
|
:::
|
||||||
|
|
||||||
:::tip Congratulations!
|
:::tip Congratulations!
|
||||||
You have successfully built and started a `nwaku` node in a Docker container. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
You have successfully built and started a `nwaku` node in a Docker container. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||||
:::
|
:::
|
||||||
|
|||||||
@ -132,6 +132,10 @@ Node is healthy
|
|||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||||
|
:::
|
||||||
|
|
||||||
:::tip Congratulations!
|
:::tip Congratulations!
|
||||||
You have successfully started, configured, and connected a `nwaku` node to the Waku Network. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
You have successfully started, configured, and connected a `nwaku` node to the Waku Network. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||||
:::
|
:::
|
||||||
|
|||||||
@ -10,10 +10,8 @@ The Waku Network is a shared p2p messaging network that is open-access, useful f
|
|||||||
3. Automatic shard selection based on content topic.
|
3. Automatic shard selection based on content topic.
|
||||||
4. Services for resource-restricted nodes, including historical message storage and retrieval, filtering, etc.
|
4. Services for resource-restricted nodes, including historical message storage and retrieval, filtering, etc.
|
||||||
|
|
||||||
If you want to learn more about the Waku Network, the [WAKU2-NETWORK RFC](https://rfc.vac.dev/waku/standards/core/10/waku2) provides an in-depth look under the hood.
|
:::tip
|
||||||
|
If you want to learn more about the Waku Network, the [The Waku Network: Technical Overview](https://blog.waku.org/2024-waku-network-tech-overview) article provides an in-depth look under the hood.
|
||||||
:::info
|
|
||||||
The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, scalability, and reasonable bandwidth usage.
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Why join the Waku network?
|
## Why join the Waku network?
|
||||||
@ -30,3 +28,7 @@ The public Waku Network replaces the previous experimental shared routing layer
|
|||||||
## Running a Waku network node
|
## Running a Waku network node
|
||||||
|
|
||||||
Have a look at the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide for instructions on running a [nwaku](https://github.com/waku-org/nwaku) node in the Waku Network. Use the Sepolia node and wallet you obtained above.
|
Have a look at the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide for instructions on running a [nwaku](https://github.com/waku-org/nwaku) node in the Waku Network. Use the Sepolia node and wallet you obtained above.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, scalability, and reasonable bandwidth usage.
|
||||||
|
:::
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user