fonstr

0.0.11 • Public • Published

fonstr

fonstr

Documentation


GitHub license npm npm Github Stars

Fonstr Relay

Fonstr is a simple and efficient Nostr relay server designed to run on mobile phones. It can be run in one line of code. For more information about fonster, see this blog post.

Quickstart

To run the Fonstr Nostr relay with just one line of code, use:

npx fonstr [port]

Replace [port] with the desired port number. If no port is provided, the server will run on port 4444 by default.

Features

  • Event filtering based on Nostr specifications
  • Efficient message handling and routing
  • Easy to set up and configure

Running the Relay

If you have installed the package globally or linked it, you can run:

fonstr [port]

Alternatively, you can run the server using node:

node index.js [port]

Now the Nostr relay server will be up and running, ready to handle incoming events and subscriptions.

To run with HTTPS, use -h or --https and use ./fullchain.pem and ./privkey.pem.

Installation from Source

First, clone the repository and navigate to the project directory:

git clone https://github.com/nostrapps/fonstr.git
cd fonstr

Then, install the necessary dependencies:

npm install

Docker

Building the Docker Image

First, navigate to the root directory of the project, where the Dockerfile is located, and run the following command:

docker build -t fonstr .

Running the Server with Docker

Run a container using the built image. Map the port and mount a volume to persist the data directory.

docker run -d -p 4444:4444 fonstr

API

This Nostr relay server supports the following Nostr event types:

  • EVENT: Publish an event
  • REQ: Subscribe to events with specified filters
  • CLOSE: Unsubscribe from a subscription
  • EOSE: End of subscription events signal

Example REQ

// Connect to the Nostr relay server using a WebSocket
const socket = new WebSocket('ws://localhost:4444');

// Subscribe to events
socket.send(JSON.stringify(['REQ', 'subscription_id', { types: [1, 2, 3], kind: 1 }]));

// Listen for incoming events
socket.addEventListener('message', (event) => {
  const data = JSON.parse(event.data);
  console.log('Received data:', data);
});

License

This project is licensed under the MIT License. See LICENSE for more information.

Contributing

Contributions are welcome! Feel free to open a pull request or report any issues you find.

License

  • MIT

Dependents (1)

Package Sidebar

Install

npm i fonstr

Weekly Downloads

2

Version

0.0.11

License

MIT

Unpacked Size

11.2 kB

Total Files

7

Last publish

Collaborators

  • melvincarvalho