> For the complete documentation index, see [llms.txt](https://minibolt.minibolt.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://minibolt.minibolt.info/bonus-guides/nostr/nostr-rs-relay.md).

# Nostr relay in Rust

A [nostr relay written in Rust](https://github.com/scsibug/nostr-rs-relay) with support for the entire relay protocol and data persistence using PostgreSQL or SQLite.

{% hint style="warning" %}
Difficulty: Medium
{% endhint %}

<figure><img src="/files/o0Jhk3CqiD9DZmGjiGvZ" alt=""><figcaption></figcaption></figure>

## What is Nostr?

Nostr is a straightforward and open protocol for global, decentralized, and censorship-resistant social media. It offers numerous advantages for users and is completely free, requiring no ID or third-party verification to begin connecting with like-minded individuals and expanding your community. While nostr is sometimes confused as just another social media platform, it goes beyond that. Explore the resources provided here to discover its significant potential.

This protocol is based on relays. Relays are servers that can be operated by anyone. By opening a persistent connection with the server, clients (or apps) can push and pull events in real time.

[Relays](https://usenostr.org/#relays) are the central element of the nostr protocol, responsible for storing events received from clients.

Crucially, relays do not communicate with each other. Only the relays you're connected to will receive and store your events. This is a key feature of nostr, emphasizing the lack of communication between relays. Therefore, you should connect to as many relays as you wish to share your data with.

Clients should always provide users the flexibility to connect to multiple relays. Users can also decide whether they want to read, write, or do both with the relays they're connected to. This means I can choose to connect to a specific relay to access content without necessarily sharing my own events there, or vice versa.

<figure><img src="/files/6QnWe38h7wYZv8yM8Z6P" alt="" width="295"><figcaption></figcaption></figure>

You can obtain more info about nostr on these additional resources:

* [awesome-nostr](https://www.nostr.net/)
* [use-nostr](https://usenostr.org/)
* [Nostr.how](https://nostr.how/en/what-is-nostr)
* [gzuuus slideshow](https://www.canva.com/design/DAFcs32eM7k/1twoK_IqInXQm5txlZBLCg/view)
* [nostr.com](https://nostr.com/)

## Requirements

* [Rustup + Cargo](/bonus-guides/system/rustup-+-cargo.md)
* [Cloudflare tunnel](/bonus-guides/networking/cloudflare-tunnel.md) (optional)
* [PostgreSQL](/bonus-guides/system/postgresql.md) (optional)

## Preparations

### Install dependencies

* With user `admin`, update and upgrade your OS

```bash
sudo apt update && sudo apt full-upgrade
```

* Make sure that all necessary software packages are installed

{% code overflow="wrap" %}

```bash
sudo apt install build-essential cmake protobuf-compiler pkg-config libssl-dev
```

{% endcode %}

{% hint style="info" %}
If you want to use the default SQLite database backend, go to the [Use the default SQLite database backend extra section](#use-the-default-sqlite-database-backend) to install the additional SQLite dependency packages
{% endhint %}

### Install Rustup + Cargo

* Check if you already have Rustup installed

```bash
rustc --version
```

**Example** of expected output:

```
rustc 1.71.0 (8ede3aae2 2023-07-12)
```

* Also Cargo

```bash
cargo -V
```

**Example** of expected output:

```
cargo 1.71.0 (cfd3bbd8f 2023-06-08)
```

{% hint style="info" %}
If you obtain "**command not found**" output, you need to follow the [Rustup + Cargo bonus guide](/bonus-guides/system/rustup-+-cargo.md) to install it and then come back to continue with the guide.
{% endhint %}

### Install PostgreSQL

{% hint style="info" %}
Skip this step if you want to use the SQLite database; go directly to the [next section](#installation).
{% endhint %}

* Check if you already have PostgreSQL installed:

```bash
psql -V
```

**Example** of expected output:

```
psql (PostgreSQL) 15.3 (Ubuntu 15.3-1.pgdg22.04+1)
```

{% hint style="info" %}
If you obtain "**command not found**" outputs, you need to follow the [PostgreSQL bonus guide](/bonus-guides/system/postgresql.md) to install it, and then come back to continue with the guide.
{% endhint %}

### Create PostgreSQL database

* With user `admin`, create a new database with the `postgres` user and assign it as the owner to the `admin` user:

{% code overflow="wrap" %}

```bash
sudo -u postgres createdb -O admin nostrsrelay
```

{% endcode %}

## Installation

* With user `admin`, go to the temporary folder:

```bash
cd /tmp
```

* Set a temporary version environment variable for the installation:

```bash
VERSION=0.10.0
```

* Clone the source code directly from the GitHub repository, then build a release version of the relay and go to the `nostr-rs-relay` folder:

{% code overflow="wrap" %}

```bash
git clone --branch $VERSION https://github.com/scsibug/nostr-rs-relay.git && cd nostr-rs-relay
```

{% endcode %}

* Build a release version of the relay:

```bash
cargo build --release
```

<details>

<summary><strong>Example</strong> of expected output ⬇️</summary>

```
    Updating crates.io index
  Downloaded pathdiff v0.2.1
  Downloaded num_cpus v1.16.0
  Downloaded indexmap v2.0.0
  Downloaded parking_lot_core v0.9.8
  Downloaded want v0.3.1
  Downloaded pest v2.7.2
  Downloaded percent-encoding v2.3.0
  Downloaded parse_duration v2.1.1
  Downloaded prost-build v0.11.9
  Downloaded clap_lex v0.5.0
  Downloaded autocfg v0.1.8
  Downloaded fastrand v2.0.0
  Downloaded is-terminal v0.4.9
  Downloaded json5 v0.4.1
  Downloaded num v0.2.1
  Downloaded paste v1.0.14
  Downloaded pin-project-internal v1.1.3
  Downloaded num-iter v0.1.43
  Downloaded fallible-streaming-iterator v0.1.9
  Downloaded md-5 v0.10.5
  Downloaded linked-hash-map v0.5.6
  Downloaded number_prefix v0.4.0
  Downloaded itoa v1.0.9
  Downloaded openssl-sys v0.9.91
  Downloaded async-lock v2.7.0
  Downloaded pest_derive v2.7.2
  Downloaded async-channel v1.9.0
  Downloaded tokio-io-timeout v1.2.0
  Downloaded async-global-executor v2.3.1
  Downloaded sync_wrapper v0.1.2
  Downloaded matchers v0.1.0
  Downloaded no-std-compat v0.4.1
  Downloaded block-padding v0.3.3
  Downloaded pest_generator v2.7.2
  Downloaded atomic-waker v1.1.1
  Downloaded pin-project-lite v0.2.12
  [...]
```

</details>

{% hint style="info" %}
If the prompt shows you this error:

`error: rustup could not choose a version of cargo to run, because one wasn't specified explicitly, and no default is configured. help: run 'rustup default stable' to download the latest stable release of Rust and set it as your default toolchain`.

You need to type **`rustup default stable`** and wait for the process to finish, then try the command again.
{% endhint %}

{% hint style="info" %}
This process can take quite **a long time**, 10-15 minutes or more, depending on the performance of your device. Please be patient until the prompt shows again.
{% endhint %}

* Install it:

<pre class="language-bash" data-overflow="wrap"><code class="lang-bash"><strong>sudo install -m 0755 -o root -g root -t /usr/local/bin /tmp/nostr-rs-relay/target/release/nostr-rs-relay
</strong></code></pre>

* Check the correct installation:

```bash
nostr-rs-relay -V
```

**Example** of expected output:

```
nostr-rs-relay 0.8.9
```

{% hint style="info" %}
If you come to update, this is the final step. Continue with the instructions in the [Upgrade section](#upgrade)
{% endhint %}

### Create the nostr user

* Create the user `nostr` with this command

```bash
sudo adduser --gecos "" --disabled-password nostrsrelay
```

**Example** of expected output:

```
Adding user `nostrsrelay' ...
Adding new group `nostrsrelay' (1010) ...
Adding new user `nostrsrelay' (1010) with group `nostrsrelay' ...
Creating home directory `/home/nostrsrelay' ...
Copying files from `/etc/skel' ...
```

* Change to the home `nostrsrelay` user folder:

```bash
sudo su - nostrsrelay
```

* **(Optional)** If you want to use the MiniBolt [`favicon.ico`](https://raw.githubusercontent.com/minibolt-guide/minibolt/refs/heads/main/resources/favicon.ico) file, download it by entering this command; if not, download your own, or skip this step, not to provide any (remember to leave the `favicon.ico` commented on the configuration file)

{% code overflow="wrap" %}

```bash
wget https://raw.githubusercontent.com/minibolt-guide/minibolt/refs/heads/main/resources/favicon.ico
```

{% endcode %}

* Create the `rs-relay` folder

```bash
mkdir nostr-rs-relay
```

* Exit to the `admin` user

```bash
exit
```

## Configuration

* Copy-paste the configuration file template into the folder you created before

```bash
sudo cp /tmp/nostr-rs-relay/config.toml /home/nostrsrelay/nostr-rs-relay/
```

* Assign the owner of the file to the `nostr` user

```bash
sudo chown nostrsrelay:nostrsrelay /home/nostrsrelay/nostr-rs-relay/config.toml
```

* **(Optional)** Delete the `nostr-rs-relay` folder to be ready for the next update

```bash
sudo rm -r /tmp/nostr-rs-relay
```

* Edit the config file, uncomment, and replace the needed information in the next parameters. Save and exit

```bash
sudo nano /home/nostrsrelay/nostr-rs-relay/config.toml
```

> > **Customize this with your own info (\*):**
> >
> > **(\*)** Click on parameter to get an example/explanation
>
> > [relay\_url = "\<yourelayurl>"](#user-content-fn-1)[^1]
>
> > [name = "\<nametotherelay>"](#user-content-fn-2)[^2]
>
> > [description = "\<descriptionrelay>"](#user-content-fn-2)[^2]
>
> > [pubkey = "\<yournostrhexpubkey>"](#user-content-fn-3)[^3]
>
> > [contact = "\<yourcontact>"](#user-content-fn-3)[^3]
>
> > [relay\_icon = "\<yourelayiconURL>"](#user-content-fn-4)[^4]

{% hint style="info" %}
If you don't have a pubkey generated yet, you can follow the [Create your nostr key pair](#create-your-nostr-key-pair) section and then continue with this.

You can use [this tool](https://nostrdebug.com/converter/) to convert your "npub" pubkey to hexadecimal format.
{% endhint %}

{% hint style="info" %}
If you want to use the default SQLite database backend, pay attention to **not including the next lines** (do not uncomment):

> engine = "postgres"

> connection = "postgresql://admin:admin\@localhost:5432/nostrsrelay"

Uncomment and replace only the next line:

> data\_directory = "/data/nostr-rs-relay/db"

-> More details and additional steps in the exclusive [extra section](#use-the-default-sqlite-database-backend)
{% endhint %}

> > **Required same as next (\*):**
> >
> > **(\*)** click on the parameter to get action to do **(\<Edit>** or **\<Uncomment>**)
>
> > [favicon = "favicon.ico"](#user-content-fn-5)[^5]
>
> > [engine = "postgres"](#user-content-fn-3)[^3]
>
> > [connection = "postgresql://admin:admin@localhost:5432/nostrsrelay"](#user-content-fn-3)[^3]
>
> > [address = "127.0.0.1"](#user-content-fn-2)[^2]
>
> > [port = 8880](#user-content-fn-2)[^2]
>
> > [remote\_ip\_header = "cf-connecting-ip"](#user-content-fn-5)[^5]

{% hint style="info" %}
If you want, use the same [`favicon.ico`](https://raw.githubusercontent.com/minibolt-guide/ramix-node/refs/heads/main/resources/favicon.ico) file downloaded before (the relay's icon of MiniBolt) and the value `relay_icon` parameter (URL -> <https://blossom.minibolt.info/75e70d1ec40f8ed7489ff17a222afc7d4ec6bd117ac827aa212b38b0ee2c480e.png>), or replace it with your info
{% endhint %}

### **Create systemd service**

The system needs to run the nostr relay daemon automatically in the background, even when nobody is logged in. We use `systemd`, a daemon that controls the startup process using configuration files.

* As user `admin`, create the service file

<pre class="language-bash"><code class="lang-bash"><strong>sudo nano /etc/systemd/system/nostr-rs-relay.service
</strong></code></pre>

* Paste the following configuration. Save and exit

```
# MiniBolt: systemd unit for nostr relay
# /etc/systemd/system/nostr-rs-relay.service

[Unit]
Description=Nostr RS relay
Requires=network-online.target postgresql.service
After=network-online.target postgresql.service

[Service]
WorkingDirectory=/home/nostrsrelay
ExecStart=/usr/local/bin/nostr-rs-relay -c /home/nostrsrelay/nostr-rs-relay/config.toml
Environment=RUST_LOG=info,nostr_rs_relay=info

User=nostrsrelay
Group=nostrsrelay

# Process management
####################
Type=simple
TimeoutStopSec=10
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
```

* Enable autoboot **(optional)**

```bash
sudo systemctl enable nostr-rs-relay
```

* Prepare `nostr-rs-relay` monitoring by the systemd journal and check the logging output. You can exit monitoring at any time with Ctrl-C

```bash
journalctl -fu nostr-rs-relay
```

## Run

To keep an eye on the software movements, [start your SSH program](/system/system/remote-access.md#access-with-secure-shell) (eg. PuTTY) a second time, connect to the MiniBolt node, and log in as `admin`

* Start the nostr-rs-relay service

```bash
sudo systemctl start nostr-rs-relay
```

<details>

<summary><strong>Example</strong> of expected output on the first terminal with <code>journalctl -fu nostr-rs-relay</code> ⬇️</summary>

```
Jun 07 10:49:45 minibolt systemd[1]: Started Nostr relay.
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.130712Z  INFO nostr_rs_relay: Starting up from main
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.150378Z  INFO nostr_rs_relay::server: listening on: 127.0.0.1:8880
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.302830Z  INFO sqlx::postgres::notice: relation "migrations" already exists, skipping
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.337047Z  INFO nostr_rs_relay::db: Postgres migration completed, at v5
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.337902Z  INFO nostr_rs_relay::server: db writer created
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.337945Z  INFO nostr_rs_relay::server: control message listener started
Jun 07 10:49:45 minibolt nostr-rs-relay[2604788]: 2024-06-07T10:49:45.338012Z  INFO nostr_rs_relay::server: reading favicon...
[...]
```

</details>

### Validation

* Ensure the service is working and listening on the default `8880` port

```bash
sudo ss -tulpn | grep nostr-rs-relay
```

Expected output:

```
tcp   LISTEN 0   128   127.0.0.1:8880   0.0.0.0:*  users:(("nostr-rs-relay",pid=138820,fd=24))
```

### Check the relay connection

-> 3 different methods ⬇️

{% tabs %}
{% tab title="Method 1" %}

* Go to the [nostr.watch](https://nostr.watch/) the website to check and test the relay connection
* Access to the URL, replacing `<relay.domain.com>` with your Nostr relay URL: `https://nostr.watch/relay/wss/relay.domain.com`, example: <https://nostr.watch/relays/wss/relay.damus.io>

**Example** of expected output:

<figure><img src="/files/8aBAQEMZbd2fjMSyQD4q" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Method 2" %}
Go to the [websocketking.com](https://websocketking.com/) website, type in the WebSocket URL box your Nostr relay URL e.g. `wss://relay.domain.com`, and click on the **\[Connect]** button

**Example** of expected output:

<figure><img src="/files/RTBiXfi0wdKBeKvNJUG6" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Method 3" %}
Go to the <https://nostrdebug.com/relay> website, type in the box your Nostr relay URL, e.g. `wss://relay.domain.com`, and click on the **\[Connect]** button. You should see the status "✅ **Connected**" in the history

<figure><img src="/files/pgFBuDfMWBTrc8EJQcjR" alt="" width="478"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

## Extras (optional)

### Use the default SQLite database backend

* With user `admin`, install the next additional dependencies

{% code overflow="wrap" %}

```bash
sudo apt install sqlite3 libsqlite3-dev
```

{% endcode %}

* Create the `nostr-rs-relay` and `db` folder

```bash
mkdir -p /data/nostr-rs-relay/db
```

* Copy-paste the configuration file template to the folder

```bash
sudo cp /tmp/nostr-rs-relay/config.toml /data/nostr-rs-relay
```

* Assign the owner to the `nostr` user

```bash
sudo chown -R nostr:nostr /data/nostr-rs-relay
```

* Edit the config file

```bash
sudo nano /data/nostr-rs-relay/config.toml
```

* Uncomment and replace the needed information in the next parameters. Save and exit

```
data_directory = "/data/nostr-rs-relay/db"
```

{% hint style="info" %}
Ignore the next lines related to PostgreSQL **(do not uncomment or edit)**:

```
engine = "postgres"

connection = "postgresql://admin:admin@localhost:5432/nostrsrelay"
```

{% endhint %}

* Delete `postgres.service` of the systemd service lines

```
Requires=network-online.target
After=network-online.target
```

{% hint style="info" %}
[Continue](#run) with the guide; the rest of the steps are the same as those for PostgreSQL use.
{% endhint %}

### Create your Nostr key pair

* Download and install the Alby Browser extension:
  * For Firefox-based browser:
    * [Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/alby/)
    * [Librewolf](https://addons.mozilla.org/en-US/firefox/addon/alby/)
    * [Tor Browser](https://addons.mozilla.org/en-US/firefox/addon/alby/) <- Follow [this guide](https://guides.getalby.com/user-guide/alby-account-and-browser-extension/alby-browser-extension/faqs-alby-extension/can-i-use-alby-with-the-tor-browser) to enable the Alby extension using the Tor Browser
  * For Chromium-based browser:
    * [Chrome](https://chrome.google.com/webstore/detail/alby-bitcoin-lightning-wa/iokeahhehimjnekafflcihljlcjccdbe)
    * [Brave](https://chrome.google.com/webstore/detail/alby-bitcoin-lightning-wa/iokeahhehimjnekafflcihljlcjccdbe)
* After installation, the browser automatically redirects you to choose a password to unlock Alby. Click on the \[**Next]** button

<figure><img src="/files/9tU6j8U9awG0x2jEwLD8" alt="" width="334"><figcaption></figcaption></figure>

{% hint style="warning" %}
Select a strong password for the Alby extension (this password is for encrypting your future Nostr private key and possible funds of the integrated LN wallet)
{% endhint %}

* Select **\[Connect with Alby]**

<figure><img src="/files/5Gc0pMpyAykulEDxdIDK" alt="" width="375"><figcaption></figcaption></figure>

* **Log in** with your **existing account** or **create a new one**

<figure><img src="/files/zSUjpGbrORPAELqxtjVq" alt="" width="262"><figcaption></figcaption></figure>

* If you selected to **create a new one**, you need to provide a valid email address

<figure><img src="/files/geHjVKRC4UeoddjkJQDQ" alt=""><figcaption></figcaption></figure>

* If you selected to **log in**, you need to provide the **email and password,** or select a **one-time login code method** that you chose

<figure><img src="/files/r1oRZzl79uqEvAA3x13T" alt=""><figcaption></figcaption></figure>

* Click on **\[Start buzzin' with Alby]**. Pin the Alby extension to the browser toolbar if you want

<figure><img src="/files/omSVbaEgOtZH1ClUqFuo" alt="" width="305"><figcaption></figcaption></figure>

* On the **Alby dashboard**, select the **\[Nostr section]**

<figure><img src="/files/nVN6XbnltyMnJBqtMwbO" alt="" width="360"><figcaption></figcaption></figure>

* Select to create a **new one nostr key pair** or **import an existing one** if you have one

<figure><img src="/files/jCuHe1LaQhaubsE89IX6" alt="" width="375"><figcaption></figcaption></figure>

* If you selected to **create a new one**, remember to backup the seed shown on the screen, check the verification box, and click on the **\[Save Master Key]** box

<figure><img src="/files/qQSt6fWVmtgoFFtIlI2r" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/tOTMZljNvT9nvJJsOUf5" alt="" width="205"><figcaption></figcaption></figure>

{% hint style="info" %}
You will see the nostr public & private keys in the proper section:
{% endhint %}

<figure><img src="/files/gAmM7GXC6kAlHLdFFWhG" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Click on the **\[Nostr Settings]** box to **obtain your private key and backup on your password manager app**; you will need it for mobile clients (e.g., Amethyst), where you will need to enter it manually. Example:
{% endhint %}

<figure><img src="/files/qKr48PGT28mcwWbXOLHm" alt="" width="290"><figcaption></figcaption></figure>

* If you selected **Import a Nostr account,** you can import using the **Nostr private key** or the **Recovery phrase**

<figure><img src="/files/jUL25EqDulBnVzaLO5wR" alt="" width="375"><figcaption></figcaption></figure>

* If you selected the Nostr private key, fill in the "**Nostr Private key**" box with your private key; it will derive for you the "**Nostr Public Key"**; check if correct

{% hint style="info" %}
If you see this banner when you enter the "**Nostr Settings**" section, this means that you should backup the private key carefully, because the existing seeds that you have are not compatible with Alby; only the private key.
{% endhint %}

<figure><img src="/files/qVAab9EVdfU9fvnVe9kb" alt=""><figcaption></figcaption></figure>

* If you selected the **Recovery phrase**, fill in the 12-24 words and click on the \[**Import Master Key]** box

<figure><img src="/files/tOTMZljNvT9nvJJsOUf5" alt="" width="205"><figcaption></figcaption></figure>

{% hint style="info" %}
You will see the **Nostr Public key** in the proper section; check if correct:
{% endhint %}

<figure><img src="/files/gAmM7GXC6kAlHLdFFWhG" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Click on the **\[Nostr Settings]** box to obtain your private key if you haven't yet:
{% endhint %}

<figure><img src="/files/qKr48PGT28mcwWbXOLHm" alt="" width="290"><figcaption></figcaption></figure>

{% hint style="success" %}
Now, you can use Alby to log in to compatible web clients using NIP-07 **\[Login from extension]**
{% endhint %}

{% hint style="info" %}
If you prefer to generate your key pair, you can mine it using the [Rana tool](https://github.com/grunch/rana) and the Minibolt node.

**Be careful when doing this**, as it will use all the available resources of the machine and could render other important applications you are running unusable. Gracefully shutdown them before starting this process
{% endhint %}

### Nostr clients

{% tabs %}
{% tab title="Coracle" %}
Coracle is a web client for the Nostr protocol focused on pushing the boundaries of what's unique about Nostr, including relay selection and management, web-of-trust based moderation and content recommendations, and privacy protection.

[Web](https://coracle.social/) | [GitHub](https://github.com/coracle-social/coracle)
{% endtab %}

{% tab title="Snort" %}
A nostr UI built with React aiming for speed and efficiency.

[Web](https://snort.social) | [Git](https://git.v0l.io/Kieran/snort)
{% endtab %}

{% tab title="Zap stream" %}
Nostr live streaming.

[Web](https://zap.stream/) | [GitHub](https://github.com/v0l/zap.stream)
{% endtab %}

{% tab title="Rana" %}
Nostr public key mining tool.

[GitHub](https://github.com/grunch/rana)
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Nostree" %}
A Nostr-based application to create, manage, and discover link lists, show notes, and other stuff.

[Web](https://nostree.me/) | [GitHub](https://github.com/gzuuus/linktr-nostr)
{% endtab %}

{% tab title="Highlighter" %}
Discover and share curated insights by people you trust.

Highlight, share, discover, comment, and earn on any text via the nostr network. Books, articles, tweets, anything!

[Web](https://highlighter.com)
{% endtab %}

{% tab title="Pinstr" %}
Pinstr is a decentralized, free, and open-source social network built on top of the Nostr Protocol for curating and sharing interests with the world.

[Web](https://pinstr.app) | [GitHub](https://github.com/sepehr-safari/pinstr)
{% endtab %}

{% tab title="Nostr nests" %}
Nostr Nests is an audio space for chatting, brainstorming, debating, jamming, micro-conferences, and more.

[Web](https://nostrnests.com) | [Github](https://gitlab.com/jam-systems/jam)
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Pleb.to" %}
`Pleb.to` does NOSTR things... documents, links, graphs, maps, and more... `Pleb.to` is a portal to your decentralized data.

[Web](https://pleb.to)
{% endtab %}

{% tab title="Nostrudel" %}
"My half-baked personal nostr client".

[Web](https://nostrudel.ninja) | [GitHub](https://github.com/hzrd149/nostrudel)
{% endtab %}

{% tab title="Habla.news" %}
Habla allows you to read, write, curate, and monetize long-form content over Nostr, a censorship-resistant protocol for social media that uses long-form nostr content.

[Web](https://habla.news) | [GitHub](https://github.com/verbiricha/habla.news)
{% endtab %}

{% tab title="Amethyst" %}
Nostr client for Android.

Amethyst brings the best social network to your Android phone.

[GitHub](https://github.com/vitorpamplona/amethyst)
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Password Manager (Vault)" %}
A free, open-source, and decentralized password manager, powered by NOSTR.

[Chrome-based extension](https://chrome.google.com/webstore/detail/vault/namadahddjnkmjgdnncdlhioopmjiflm)
{% endtab %}

{% tab title="njump" %}
njump is a HTTP Nostr gateway that allows you to browse profiles, notes, and relays; it is an easy way to preview a resource and then open it with your preferred client.

[Web](https://njump.me/) | [GitHub](https://github.com/fiatjaf/njump)
{% endtab %}

{% tab title="exit.pub" %}
Tool for migrating your entire past Twitter activity to Nostr.

[Web](https://exit.pub/)
{% endtab %}
{% endtabs %}

### Broadcast the past events to your new relay

If you want all your past events to be accessible through your new relay, you can back them up by following these instructions:

* Go to the [metadata.nostr.com](https://metadata.nostr.com) website, log in **\[Load My Profile]**, and click on **\[Relays]**
* Add your new Nostr relay **`[wss://relay.domain.com]`** address to the list of preferred relays in your profile (in the empty box below), select the **read+write** option, and click the **\[Update]** button.

You can take the opportunity to add more preferred relays to your profile to also push events to them, selected from this [list](https://nostr.watch/)

* Go to the [NostrSync](https://nostrsync.vercel.app/) webpage and log in **\[Get from extension] (Alby)**, or manually enter the \[npub...] of your Nostr profile
* Click the **\[Backup & Broadcast]** button...

<figure><img src="/files/bL0FenH2WkV66Mnniq2E" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Please **wait patiently** until all processes are finished. This might take some time, depending on the number of events you've published on Nostr with that pubkey, meaning the interactions you've had on Nostr.

Optionally, you can save a copy of all your events locally, as a banner will appear after fetching the events from the relays. These can be restored later using the \[Restore] button and broadcasting again to the relays.
{% endhint %}

### Remote access over Tor <a href="#remote-access-over-tor" id="remote-access-over-tor"></a>

To use your Nostr relay when you're on the go, you can easily create a Tor hidden service.

* With the user `admin`, edit the `torrc` file

```bash
sudo nano +63 /etc/tor/torrc --linenumbers
```

* Add the following lines in the "location hidden services" section, below "`## This section is just for location-hidden services ##`" in the torrc file. Save and exit

```
# Hidden Service Nostr RS relay
HiddenServiceDir /var/lib/tor/hidden_service_nostr_rs_relay/
HiddenServiceEnableIntroDoSDefense 1
HiddenServicePoWDefensesEnabled 1
HiddenServicePort 80 127.0.0.1:8880
```

* Reload the Tor configuration to apply changes

```bash
sudo systemctl reload tor
```

* Get your Onion address

```bash
sudo cat /var/lib/tor/hidden_service_nostr_rs_relay/hostname
```

Expected output:

```
abcdefg..............xyz.onion
```

{% hint style="info" %}
You should now be able to connect to your Nostr relay remotely via Tor using your hostname. eg: `ws://abcdefg..............xyz.onion`
{% endhint %}

#### **Allow insecure WebSocket connections in Firefox-based browsers**

This is necessary to access you `ws://` URL, since Tor does not use `wss://` due to the Tor network being encrypted by design

* Go to the browser configuration by typing `about:config` in the address bar. Press the button: "Accept the Risk and Continue" when it shows you.
* Type `network.websocket.allowInsecureFromHTTPS` in the search bar
* Set `network.websocket.allowInsecureFromHTTPS` to `true`

<figure><img src="/files/TNae9kg83qzDoTcijDTy" alt=""><figcaption></figcaption></figure>

### Use Cloudflare tunnel to expose publicly <a href="#use-cloudflare-tunnel-to-expose-publicly" id="use-cloudflare-tunnel-to-expose-publicly"></a>

You may want to expose your Nostr relay publicly using a clearnet address. To do this, follow the next steps:

* Follow the [Cloudflare tunnel](/bonus-guides/networking/cloudflare-tunnel.md) guide to install and create the Cloudflare tunnel from your MiniBolt to Cloudflare
* When you finish the [Create a tunnel and give it a name](/bonus-guides/networking/cloudflare-tunnel.md#id-3-create-a-tunnel-and-give-it-a-name) section, you can skip the [Start routing traffic](/bonus-guides/networking/cloudflare-tunnel.md#id-5-start-routing-traffic) section and go to your [Cloudflare account](https://dash.cloudflare.com/login) -> From the left sidebar, select **Websites,** click on your site, and again from the new left sidebar, click on **DNS -> Records**
* Click on the **\[+ Add record]** button

<figure><img src="/files/q09jkvsmRRLFLr0XGQaI" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}

> Select the **CNAME** type on the drop down

> Type the selected subdomain (e.g service name "relay") as the **Name** field

> Type the tunnel `<UUID>` of your previously obtained in the [Create a tunnel and give it a name](/bonus-guides/networking/cloudflare-tunnel.md#id-3-create-a-tunnel-and-give-it-a-name) section as the **Target** field

> Ensure you enable the switch on the `Proxy status` field to be "Proxied"

Click on the **\[Save]** button to save the new DNS registry
{% endhint %}

* If you didn't follow before, continue with the [Configuration](/bonus-guides/networking/cloudflare-tunnel.md#configuration) section of the [Cloudflare tunnel guide](/bonus-guides/networking/cloudflare-tunnel.md) to [Increase the maximum UDP Buffer Sizes](/bonus-guides/networking/cloudflare-tunnel.md#increase-the-maximum-udp-buffer-sizes) and [Create systemd service](/bonus-guides/networking/cloudflare-tunnel.md#create-systemd-service)
* Edit the`config.yml`

```bash
sudo nano /home/admin/.cloudflared/config.yml
```

* Add the next lines to the `config.yml`

<pre><code># Nostr RS relay
  - hostname: <a data-footnote-ref href="#user-content-fn-6">&#x3C;subdomain></a>.<a data-footnote-ref href="#user-content-fn-7">&#x3C;domain.com></a>
    service: http://localhost:8880
</code></pre>

{% hint style="info" %}

> You can choose the subdomain you want; the above information is an example, but keep in mind to use the port `8880` and always maintaining the "`- service: http_status:404`" line at the end of the file
> {% endhint %}

* Restart Cloudflared to apply changes

```bash
sudo systemctl restart cloudflared
```

{% hint style="info" %}
Try to access the newly created public access to the service by going to the `wss://<subdomain>. <domain.com>`, i.e, `wss://relay.domain.com`
{% endhint %}

#### Add an exception on Cloudflare to allow incoming connections from Tor

1. Go to your [Cloudflare account](https://dash.cloudflare.com/login) -> From the left sidebar, select **Websites,** click on your site
2. Drop down the `Security` submenu -> Click on `Security rules` -> `Create Rule` -> `Custom rules`
3. Fill the fields like this:

<figure><img src="/files/6Jh4QgtUFms31No72dRX" alt=""><figcaption></figcaption></figure>

4. Click on the `[Save]` button to apply changes

#### Validation

Display the related log events to ensure this rule is being applied correctly:

1\. On the `Security` submenu -> Click on `Analytics` -> `Events` (Tab)

2. Add the next filters by clicking the `[+ Add filter]` button:
   1. In the dropdown `Host` -> `equals` -> `<relay.domain.com>` click on `[Apply]`

<div align="center"><figure><img src="/files/PGgfARSFIWyX11gFGZJz" alt="" width="482"><figcaption></figcaption></figure></div>

{% hint style="info" %}
Replace `<relay.domain.com>` with your proper subdomain relay
{% endhint %}

3. Press again the `[+ Add filter]` button: In the dropdown `Action` -> `equals` -> `Skip` click on `[Apply]`

<figure><img src="/files/V3etuQJ2rD9eBGbBt1Su" alt=""><figcaption></figcaption></figure>

Example of expected output:

<figure><img src="/files/eYd5XANAyVTR9Am2G1Dv" alt=""><figcaption><p>Sampled logs</p></figcaption></figure>

## Upgrade

* With user `admin`, stop `nostr-rs-relay` service

```bash
sudo systemctl stop nostr-rs-relay
```

* Follow the complete [Installation](#installation) section with the new VERSION number changed to match the [latest tag release](https://github.com/scsibug/nostr-rs-relay/tags)
* Replace the `config.toml` file with the new one of the new version **(if needed)**

{% hint style="warning" %}
**This step is only necessary if you see changes in the config file template from your current version until the current release (not common)**. You can view this [history link](https://github.com/scsibug/nostr-rs-relay/commits/master/config.toml). If there are no changes, jump directly to the next **"Start `nostr-rs-relay` service again" >**`sudo systemctl start nostr-rs-relay` step
{% endhint %}

-> Here are 2 cases depending on your chosen database backend:

{% tabs %}
{% tab title="Case 1: PostgreSQL database backend" %}

* Backup the `config.toml` file to keep a copy of your old configuration

{% code overflow="wrap" %}

```bash
sudo cp /home/nostrsrelay/nostr-rs-relay/config.toml /home/nostrsrelay/nostr-rs-relay/config.toml.backup
```

{% endcode %}

* Assign the owner of the backup file to the `nostr` user

{% code overflow="wrap" %}

```bash
sudo chown nostrsrelay:nostrsrelay /home/nostrsrelay/nostr-rs-relay/config.toml.backup
```

{% endcode %}

* Replace the `config.toml` file with the new version

```bash
sudo cp /tmp/nostr-rs-relay/config.toml /home/nostrsrelay/nostr-rs-relay/
```

* Edit the config file and replace it with the same old information as the file you had. Save and exit

```bash
sudo nano /home/nostrsrelay/nostr-rs-relay/config.toml
```

{% endtab %}

{% tab title="Case 2: SQLite database backend" %}

* Backup the `config.toml` file to keep a copy of your old configuration

{% code overflow="wrap" %}

```bash
sudo cp /data/nostr-rs-relay/config.toml /data/nostr-rs-relay/config.toml.backup
```

{% endcode %}

* Assign the owner of the backup file to the `nostr` user

```bash
sudo chown nostr:nostr /data/nostr-rs-relay/config.toml.backup
```

* Replace the `config.toml` file with the new version

```bash
sudo cp /tmp/nostr-rs-relay/config.toml /data/nostr-rs-relay/
```

* Edit the config file and replace it with the same old information as the file you had. Save and exit

```bash
sudo nano /data/nostr-rs-relay/config.toml
```

{% endtab %}
{% endtabs %}

* Start `nostr-rs-relay` service again

```bash
sudo systemctl start nostr-rs-relay
```

* Delete the `nostr-rs-relay` folder to be ready for the next update

```bash
sudo rm -r /tmp/nostr-rs-relay
```

## Uninstall

{% hint style="danger" %}
Warning: This section removes the installation. Only run these commands if you intend to uninstall
{% endhint %}

### Uninstall service

* With the user `admin`, stop nostr-relay

```bash
sudo systemctl stop nostr-rs-relay
```

* Disable autoboot (if enabled)

```bash
sudo systemctl disable nostr-rs-relay
```

* Delete `nostr-relay` service

```bash
sudo rm /etc/systemd/system/nostr-rs-relay.service
```

### Delete user & group

* Delete the nostr user. Don't worry about `userdel: nostr mail spool (/var/mail/nym) not found` output; the uninstall has been successful

```bash
sudo userdel -rf nostrsrelay
```

### Delete the PostgreSQL database [(if used)](#install-postgresql)

* Delete the `nostrelay` database

```bash
sudo -u postgres psql -c "DROP DATABASE nostrsrelay;"
```

### Delete SQLite data directory [(if used)](#use-the-default-sqlite-database-backend)

* Delete the nostr relay data folder

```bash
sudo rm -r /data/nostr-rs-relay
```

### Uninstall the nostr relay of the Cloudflare tunnel

* Staying with user `admin`, edit `config.yml`

```bash
nano /home/admin/.cloudflared/config.yml
```

* Comment or delete the Nostr RS relay associated ingress rule. Save and exit

```
# MiniBolt: cloudflared configuration
# /home/admin/.cloudflared/config.yml

tunnel: <UUID>
credentials-file: /home/admin/.cloudflared/<UUID>.json

ingress:

# Nostr RS relay
#  - hostname: relay.<domain.com>
#    service: ws://localhost:8880

  - service: http_status:404
```

* Restart the Cloudflare tunnel to apply the changes

```bash
sudo systemctl restart cloudflared
```

### Uninstall binaries

* With the user `admin`, delete the nostr-rs-relay binary from the system

```bash
sudo rm /usr/local/bin/nostr-rs-relay
```

## Port reference

<table><thead><tr><th align="center">Port</th><th width="100">Protocol<select><option value="LmuATJVLQLDK" label="TCP" color="blue"></option><option value="zaf3gw51t80V" label="SSL" color="blue"></option><option value="a78ngs5s3uXp" label="UDP" color="blue"></option></select></th><th align="center">Use</th></tr></thead><tbody><tr><td align="center">8880</td><td><span data-option="LmuATJVLQLDK">TCP</span></td><td align="center">Default port</td></tr></tbody></table>

[^1]: **\<Edit>** This information will be get later on the [Cloudflare tunnel](#cloudflare-tunnel) section

[^2]: **\<Edit>**

[^3]: **\<Uncomment> & \<Edit>**

[^4]: **\<Uncomment> & \<Edit> with** [**https://twofaktor.github.io/logo\_circle%2BB.png**](https://twofaktor.github.io/logo_circle%2BB.png) **if you want**

[^5]: **\<Uncomment>**

[^6]: Replace with the selected name of your service i.e: `relay`

[^7]: Replace with your domain i.e: `domain.com`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://minibolt.minibolt.info/bonus-guides/nostr/nostr-rs-relay.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.