mirrors/lnbits-legend
1
0
Fork 0
mirror of https://github.com/lnbits/lnbits-legend.git synced 2024-11-20 10:39:59 +01:00
Code Issues Packages Projects Releases Wiki Activity
42bd5ea989
lnbits-legend/lnbits/extensions/subdomains/README.md
Kristjan 94b3416300 prettier formatting
2021-01-02 16:58:03 +01:00

2.3 KiB
Raw Blame History

Subdomains Extension

So the goal of the extension is to allow the owner of a domain to sell their subdomain to the anyone who is willing to pay some money for it.

Requirements

  • Free cloudflare account
  • Cloudflare as a dns server provider
  • Cloudflare TOKEN and Cloudflare zone-id where the domain is parked

Usage

  1. Register at cloudflare and setup your domain with them. (Just follow instructions they provide...)
  2. Change DNS server at your domain registrar to point to cloudflare's
  3. Get Cloudflare zoneID for your domain
  4. get Cloudflare API TOKEN
  5. Open the lnbits subdomains extension and register your domain with lnbits
  6. Click on the button in the table to open the public form that was generated for your domain
  • Extension also supports webhooks so you can get notified when someone buys a new domain

API Endpoints

  • Domains
    • GET /api/v1/domains
    • POST /api/v1/domains
    • PUT /api/v1/domains/<domain_id>
    • DELETE /api/v1/domains/<domain_id>
  • Subdomains
    • GET /api/v1/subdomains
    • POST /api/v1/subdomains/<domain_id>
    • GET /api/v1/subdomains/<payment_hash>
    • DELETE /api/v1/subdomains/<subdomain_id>

Useful

Cloudflare