https://github.com/lnbits/nostrnip5

https://github.com/lnbits/nostrnip5

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/lnbits/nostrnip5
• Owner: lnbits
• License: mit
• Created: 2023-02-14T12:49:03.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T09:46:24.000Z (about 2 months ago)
• Last Synced: 2024-10-29T11:44:25.193Z (about 2 months ago)
• Language: HTML
• Size: 549 KB
• Stars: 3
• Watchers: 4
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-lnbits - NOSTR-NIP5 - Allows users to sell NIP-05 verification to other nostr users on a domain they control. (Uncategorized / Uncategorized)

README

        
# Nostr NIP-05 - [LNbits](https://github.com/lnbits/lnbits) extension

For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)

## Allow users to NIP-05 verify themselves at a domain you control

This extension allows users to sell NIP-05 verification to other nostr users on a domain they control.

## Usage

1. Create a Domain by clicking "NEW DOMAIN"\

2. Fill the options for your DOMAIN

   - select the wallet

   - select the fiat currency the invoice will be denominated in

   - select an amount in fiat to charge users for verification

   - enter the domain (or subdomain) you want to provide verification for

     - Note, you must own this domain and have access to a web server

3. You can then use share your signup link with your users to allow them to sign up

## Installation

In order for this to work, you need to have ownership of a domain name, and access to a web server that this domain is pointed to.

Then, you'll need to set up a proxy that points `https://{your_domain}/.well-known/nostr.json` to `https://{your_lnbits}/nostrnip5/api/v1/domain/{domain_id}/nostr.json`

Example nginx configuration

```

## Proxy Server Caching

proxy_cache_path /tmp/nginx_cache keys_zone=nip5_cache:5m levels=1:2 inactive=300s max_size=100m use_temp_path=off;

location /.well-known/nostr.json {

   proxy_pass https://{your_lnbits}/nostrnip5/api/v1/domain/{domain_id}/nostr.json;

   proxy_set_header Host {your_lnbits};

   proxy_ssl_server_name on;

   expires 5m;

   add_header Cache-Control "public, no-transform";

   proxy_cache nip5_cache;

   proxy_cache_lock on;

   proxy_cache_valid 200 300s;

   proxy_cache_use_stale error timeout invalid_header updating http_500 http_502 http_503 http_504;

}

```

### Example Caddy configuration

```

my.lnbits.instance {

    reverse_proxy {your_lnbits}

}

nip.5.domain {

    route /.well-known/nostr.json {

        rewrite * /nostrnip5/api/v1/domain/{domain_id}/nostr.json

        reverse_proxy {your_lnbits}

    }

}

```