GitHubHelp

zatzby/nost-py

A nostr relay backed by a postgresql database, run with docker-compose

★ 0Forks 0GitHub ↗Compare

README

Nostpy

Pylint_score

Ubuntu Build

A simple and easy to deploy nostr relay using asyncio & websockets to server Nostr clients

Description

nostpy_auto_x2_colored_toned_light_ai

A containerized Python relay paried with a Postgres databse, reachable via a NGINX reverse proxy. This has been tested on Coracle, Iris.to and Snort.social clients and works for the NIPS listed below.

Numerous branches in development,trying to improve performance, reliability and ease of use. The Datadog branch deploys a Datadog agent container to collect logs, metrics and traces to better observe application performance.

Requirements

  • Ubuntu 22.04 amd64 host server (Will likely work on other versions but this is all that has been tested)
  • At least 2 GB of available RAM ( 4GB recomended )
  • Your own domain
  • Right now the main branch deploys the Datadog agent along with the application containers and has APM, DBM, and NPM preconfigured as well as some custom nostr StatsD metrics.
    • If you don't have a Datadog developer account, you can apply for a developer account here, or sign up for a trial here to get a Datadog API key.
    • If you don't want to use the Datadog agent, simply don't enter the DD_API_KEY variable in the .env file and comment the service out from the docker-compose.yaml file.

Instructions

Setup

To setup this program, you need to update the variables in the nostpy/docker_stuff/.env, for example:

POSTGRES_DB=nostr
POSTGRES_USER=nostr
POSTGRES_PASSWORD=nostr
POSTGRES_PORT=5432
POSTGRES_HOST=localhost
DD_ENV=<DATADOG_ENV_TAG>
DD_API_KEY=<YOUR_DATADOG_API_KEY>
DOMAIN_NAME=<YOUR_DOMAIN_NAME>
HEX_PUBKEY=<YOUR_HEX_PUBLIC_KEY_FOR_NIP_11>
CONTACT=<YOUR_EMAIL_OR_NPUB>

Aside from adding the environmental variables, all you need to do is run the menu.py script to load the menu. Once you select the Execute server setup script option, the script will install all dependencies, setup your NGINX reverse proxy server and request an TLS certificate, load environmental variables, build and launch the application and database containers. From there you are ready to start relaying notes!

To get started run the command below from the main repo direcotory to bring up the NostPy menu

python3 menu.py

This will bring up the menu below and you can control the program from there!

Screenshot from 2023-07-29 18-33-34

image

Install demo

Future plans

This is relay is actively worked on, it's is only a proof of concept right now. Will contine to add features, bug fixes and documentation weekly, check back for updates.

Supported NIPs

unchecked NIPS are on the roadmap

  • NIP-01: Basic protocol flow description
  • NIP-02: Contact list and petnames
  • NIP-04: Encrypted Direct Message
  • [] NIP-09: Event deletion
  • NIP-11: Relay information document
  • [] NIP-11a: Relay Information Document Extensions
  • [] NIP-12: Generic tag queries
  • [] NIP-13: Proof of Work
  • NIP-15: End of Stored Events Notice
  • NIP-16: Event Treatment
  • NIP-25: Reactions

Contributing

If you would like to contribute feel free to fork and put in a PR! Also please report any bugs in the issues section of this repo.

Contributors

UTXOnly

Issues