matrix-nostr-bridge

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #golang #go #rust #deep-learning #nodejs #macos #java #vue #security #openai

matrix-nostr-bridge

(★ 48)

Bridge between Matrix and Nostr communication protocols

matrix-nostr-bridge 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# matrix-nostr-bridge
Bridge between Matrix and Nostr communication protocols.

If you like the idea, give it a Github star :star: right away!

# Setup

- get familiar with [matrix-commander](https://github.com/8go/matrix-commander) (Python) or [matrix-commander](https://github.com/8go/matrix-commander-rs) (Rust)
- get familiar with [nostr-commander](https://github.com/8go/nostr-commander-rs) (Rust)
- configure and run 2 `matrix-commander`s, one for Matrix-to-Nostr, another one for Nostr-to-Matrix
- configure and run 2 `nostr-commander`s, one for Matrix-to-Nostr, another one for Nostr-to-Matrix
- if desired write a script or program to filter and customize the data flow
- if you use a filter-and-customize process you most likely want to use the options `--output json` with `matrix-commander`s and `nostr-commander`s and work with JSON formatted messages
- if you connect the `matrix-commander`s and `nostr-commander`s together straight with a pipe you need to use `--output text`

# Architecture

```mermaid
flowchart BT
  subgraph Nostr-to-Matrix
  direction BT
  E((Nostr-network)) -- some Nostr note --> F(nostr-commander with --listen) -- via pipe --> G(matrix-commander with --message) -- some Matrix message --> H((Matrix-network))
  end
  subgraph Matrix-to-Nostr
  direction TB
  A((Matrix-network)) -- some Matrix message --> B(matrix-commander with --listen) -- via pipe --> C(nostr-commander with --publish) -- some Nostr note --> D((Nostr-network))
  end
```

Or most likely you would want to filter and customize the messages. You can do this by putting a process in the middle that reads from stdin and writes to stdout. Input gets piped into the custom process which processes input line-by-line and generates its streamed output on stdout.

```mermaid
flowchart BT
  subgraph Nostr-to-Matrix
  direction BT
  E((Nostr-network)) -- some Nostr note --> F(nostr-commander with --listen) -- via pipe --> I{filter and customize} -- via pipe --> G(matrix-commander with --message) -- some Matrix message --> H((Matrix-network))
  end
  subgraph Matrix-to-Nostr
  direction TB
  A((Matrix-network)) -- some Matrix message --> B(matrix-commander with --listen) -- via pipe --> J{filter and customize} -- via pipe --> C(nostr-commander with --publish) -- some Nostr note --> D((Nostr-network))
  end
```
# Running It

After having done the initial `matrix-commander` configuration like `--login` and `--verify`, and 
having done the initial `nostr-commander` configuration like `--create-user`, `--subscribe-author`, `--subscribe-pubkey`, etc.,
the simplest set-up to get data from Matrix to Nostr is:

```matrix-commander --listen forever --output text ... other options | nostr-commander --publish '_' ... other options```

Vice versa in the other direction:

```nostr-commander --listen  --output text ... other options | matrix-commander --message '_' ... other options```

And if you have a `filter-and-customize` process, then this turns into:

```matrix-commander --listen forever --output json ... other options | filter-and-customize | nostr-commander --publish '_' ... other options```

and

```nostr-commander --listen  --output json ... other options | filter-and-customize | matrix-commander --message '_' ... other options```

# Contribute

This tool is more geared towards tinkerers.
The basic functionality and feature set for a Proof-of-concept bridge
or a bridge for family-and-friends is there. 
If you need more feature, please contribute the corresponding code
to the corresponding `matrix-commander` and `nostr-commander` repos.
:clap:

matrix-nostr-bridge

matrix-nostr-bridge 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

matrix-nostr-bridge

matrix-nostr-bridge 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README