NVK.org / How to setup LNURL Proxy using Github Pages



If you already did the NIP5 guide skip #5 "Create a new file and dir"

  1. Buy a domain 😅
  2. Setup Domain DNS records to point to GitHub Pages:
      
    | Type | Host           | Answer          | TTL | Priority |
    |------|----------------|-----------------|-----|----------|
    | A    | YOURDOMAIN.COM | 185.199.108.153 | 300 |          |
    | A    | YOURDOMAIN.COM | 185.199.109.153 | 300 |          |
    | A    | YOURDOMAIN.COM | 185.199.110.153 | 300 |          |
    | A    | YOURDOMAIN.COM | 185.199.111.153 | 300 |          |
    
    
  3. Create a new github repo github.com/new
  4. ###### -------------- If you already did nip5 start here -------------- ######
  5. Create a new file and diryour-repo/.well-known/lnurlp/YOUR-NICK[no extension] example mine
  6. Add this content to you file. Change [YOUR-NICK] to reflect yours:
    {
      "status":"OK",
      "tag":"payRequest",
      "commentAllowed":255,
      "callback":"https://getalby.com/lnurlp/YOUR-NICK/callback",
      "metadata":"[[\"text/identifier\", \"YOUR-NICK@getalby.com\"], [\"text/plain\", \"Sats for YOUR-NICK\"]]",
      "minSendable":1000,"maxSendable":11000000000,
      "payerData":
        {
          "name":{"mandatory":false},
          "email":{"mandatory":false}
        }
    }
      
  7. ###### -------------- you might already have done the below, so you might be done.
    Go ahead and try sending to YOUR-NICK@YOUR-DOMAIN.TLD -------------- ######
  8. Create a new file in the root folder _config.yml and add this line
    include: [".well-known"]
  9. Navigate to github.com/[USER]/[YOUR-REPO]/settings/pages
  10. Under "Build and deployment" select "Deploy from branch" then below select "Main/Master" branch
  11. Under "Custom domain" type your naked YOURDOMAIN.COM (github might complain, ignore)
  12. Below it, check Enforce HTTPS. Sometimes this may take a few minutes to be available.
  13. Then head over branle.netlify.app/settings or astral.ninja/settings (using an extension like Alby or nos2x)
  14. edit the NIP-05 Indentifier field to reflect "bob@YOURDOMAIN.com" and press Save
  15. you are all set now, enjoy the vanity address.