waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add libpq pre-req

This commit is contained in:
LordGhostX 2023-07-04 13:33:22 +01:00
parent d5706faada
commit 45202adfc6
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
6 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.cspell.json
View File

@ -48,7 +48,9 @@
"extip",
"staticnode",
"permissioned",
"Secp"
"Secp",
"libpq",
"dylib"
],
"flagWords": [],
"ignorePaths": [

2
docs/guides/nodes-and-sdks.md
View File

@ -45,4 +45,4 @@ Waku provides integrations tailored for mobile applications, enabling Waku to ru
| JSON-RPC API | `JSON-RPC` API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | |
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `js-waku` | |
| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `js-waku` project from various example templates | |
| [nwaku-compose](https://github.com/alrevuelta/nwaku-compose) | Pre-configured `docker-compose` setup for running and monitoring a `nwaku` node using Prometheus and Grafana. | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |
| [nwaku-compose](https://github.com/alrevuelta/nwaku-compose) | Pre-configured Docker Compose setup for running and monitoring a `nwaku` node using Prometheus and Grafana. | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |

13
docs/guides/nwaku/build-source.md
View File

@ -11,7 +11,7 @@ This guide provides detailed steps to build a `nwaku` node from the source code
## Install Dependencies
To build `nwaku`, you need the standard developer tools, including a C compiler, Make, Bash, and Git.
To build `nwaku`, you need the standard developer tools, including a C compiler, Make, Bash, Git, and PostgreSQL client library.
```mdx-code-block
import Tabs from '@theme/Tabs';
@ -22,14 +22,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="debian" label="Debian and Ubuntu">
```bash
sudo apt-get install build-essential git
sudo apt-get install build-essential git libpq5
```
</TabItem>
<TabItem value="fedora" label="Fedora">
```bash
sudo dnf install @development-tools
sudo dnf install @development-tools git libpq-devel
```
</TabItem>
@ -37,14 +37,17 @@ sudo dnf install @development-tools
```bash
# Using your favorite AUR helper
[AUR HELPER] -S base-devel
sudo [AUR HELPER] -S base-devel git postgresql-libs
```
</TabItem>
<TabItem value="mac" label="MacOS (Homebrew)">
```bash
brew install cmake
brew install cmake git postgresql@15
# Create a symbolic link to libpq.5.dylib in /usr/local/lib/
sudo mkdir -p /usr/local/lib/
sudo ln -s /opt/homebrew/opt/postgresql@15/lib/libpq.5.dylib /usr/local/lib/libpq.dylib
```
</TabItem>

6
docs/guides/reference/node-config-options.md
View File

@ -16,7 +16,7 @@ Here are the available node configuration options, along with their default valu
| Name | Default Value | Description |
| - | - | - |
| `log-level` | `logging.LogLevel.INFO` | Sets the log level for process. Supported levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL |
| `log-format` | `logging.LogFormat.TEXT` | Specifies what kind of logs should be written to stdout. Suported formats: TEXT, JSON |
| `log-format` | `logging.LogFormat.TEXT` | Specifies what kind of logs should be written to stdout. Supported formats: TEXT, JSON |
## General Node Config
@ -48,7 +48,7 @@ Here are the available node configuration options, along with their default valu
| `relay` | `true` | Enable relay protocol: true\|false |
| `relay-peer-exchange` | `false` | Enable gossipsub peer exchange in relay protocol: true\|false |
| `rln-relay` | `false` | Enable spam protection through rln-relay: true\|false |
| `rln-relay-cred-path` | | The path for peristing rln-relay credential |
| `rln-relay-cred-path` | | The path for persisting rln-relay credential |
| `rln-relay-membership-index` | `0` | The index of credentials to use |
| `rln-relay-membership-group-index` | `0` | The index of credentials to use, within a specific rln membership set |
| `rln-relay-pubsub-topic` | `/waku/2/default-waku/proto` | The pubsub topic for which rln-relay gets enabled |
@ -73,7 +73,7 @@ Here are the available node configuration options, along with their default valu
| `store` | `false` | Enable/disable waku store protocol |
| `storenode` | | Peer multiaddress to query for storage |
| `store-message-retention-policy` | time:172800 | Message store retention policy. Time retention policy: 'time:<seconds\>'. Capacity retention policy: 'capacity:<count\>'. Set to 'none' to disable |
| `store-message-db-url` | `sqlite://store.sqlite3` | The database connection URL for peristent storage |
| `store-message-db-url` | `sqlite://store.sqlite3` | The database connection URL for persistent storage |
| `store-message-db-vacuum` | `false` | Enable database vacuuming at start. Only supported by SQLite database engine |
| `store-message-db-migration` | `true` | Enable database migration at start |
| `store-resume-peer` | | Peer multiaddress to resume the message store at boot |

1
docs/powered-by-waku.mdx
View File

@ -34,4 +34,3 @@ import { PoweredBy } from "@site/src/components/mdx";
},
]}
/>
``

6
docusaurus.config.js
View File

@ -142,7 +142,7 @@ const config = {
title: "Community",
items: [
{
href: "https://discord.waku.org/",
href: "https://discord.waku.org",
label: "Discord",
},
{
@ -154,7 +154,7 @@ const config = {
label: "Telegram",
},
{
href: "https://forum.vac.dev/",
href: "https://forum.vac.dev",
label: "Vac Forum",
},
],
@ -171,7 +171,7 @@ const config = {
label: "Blog",
},
{
href: "https://rfc.vac.dev/",
href: "https://rfc.vac.dev",
label: "Vac RFCs",
},
],