From 0fddeb7ada1bf4395b227bfe6263f14d6e3d629e Mon Sep 17 00:00:00 2001 From: hzrd149 Date: Sat, 12 Oct 2024 11:37:23 +0100 Subject: [PATCH 1/4] add nsite draft --- nsite.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 nsite.md diff --git a/nsite.md b/nsite.md new file mode 100644 index 00000000..14c23d9e --- /dev/null +++ b/nsite.md @@ -0,0 +1,77 @@ +NIP-XX +====== + +Static Websites (nsite) +----------------------- + +`draft` `optional` + +This nip describes a method by which static websites can be hosted under public keys using specialized host servers + +### Static file definition + +A static file event uses the kind `34128` and MUST have a `d` and `x` tag + +The `d` tag MUST be an absolute path ending with a filename and extension +The `x` tag MUST be the sha256 hash of the file that will be served under this path + +For example: + +```json +{ + "content": "", + "created_at": 1727373475, + "id": "5324d695ed7abf7cdd2a48deb881c93b7f4e43de702989bbfb55a1b97b35a3de", + "kind": 34128, + "pubkey": "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5", + "sig": "f4e4a9e785f70e9fcaa855d769438fea10781e84cd889e3fcb823774f83d094cf2c05d5a3ac4aebc1227a4ebc3d56867286c15a6df92d55045658bb428fd5fb5", + "tags": [ + ["d", "/index.html"], + ["x", "186ea5fd14e88fd1ac49351759e7ab906fa94892002b60bf7f5a428f28ca1c99"] + ] +} +``` + +### Host server implementation + +A host server is an http server that is responsible for serving the static files for pubkeys + +#### Resolving Pubkeys + +When a request is made to the host server with a subdomain of a `npub`, the server MUST use it as the pubkey when searching for the static file + +example + +``` +Host: npub10phxfsms72rhafrklqdyhempujs9h67nye0p67qe424dyvcx0dkqgvap0e.nsite-host.com +``` + +If the requests `Host` does not have a subdomain server MUST lookup any `CNAME` or `TXT` DNS records for the domain and attempt to resolve the pubkey from them + +The host server MAY serve anything at its own root domain `nsite-host.com` ( a landing page for example ) + +#### Resolving Paths + +When the host server receives a request and is able to determine the pubkey. it should fetch the users `10002` [NIP-65](https://github.com/nostr-protocol/nips/blob/master/65.md) relay list and lookup `34128` events with a `d` tag matching the requested path + +```json +// For /index.html +{ "kinds": [34128], "authors": [pubkey], "#d": ["/index.html"] } +``` + +If the request path does not end with a filename the host server MUST fallback to using the `index.html` filename + +For example: `/` -> `/index.html` or `/blog/` -> `/blog/index.html` + +#### Resolving Files + +Once the host server has found the `34128` event for the pubkey and path it should use the sha256 hash defined in the `x` tag to retrieve the file + +If the pubkey has a `10063` [BUD-03 user servers](https://github.com/hzrd149/blossom/blob/master/buds/03.md) event the server MUST attempt to retrieve the file from the listed servers using the path defined in [BUD-01](https://github.com/hzrd149/blossom/blob/master/buds/01.md#get-sha256---get-blob) +If a pubkey does not have a `10063` event the host server may choose to fallback to a predefined list of Blossom servers + +The host server MUST forward the `Content-Type`, and `Content-Length` header from the Blossom server. If none are defined the host server MAY set `Content-Type` from the file extension in the requested path + +#### Handling Not Found + +If a host server is unable to find a `34128` event matching the requested path it MUST use `/404.html` as a fallback path From 120ff9380118d46ea6b45160f6ce65ede2c19cf0 Mon Sep 17 00:00:00 2001 From: hzrd149 Date: Sat, 19 Oct 2024 15:14:25 +0100 Subject: [PATCH 2/4] remove line about fallback servers --- nsite.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nsite.md b/nsite.md index 14c23d9e..852446b9 100644 --- a/nsite.md +++ b/nsite.md @@ -1,8 +1,8 @@ NIP-XX ====== -Static Websites (nsite) ------------------------ +Static Websites +--------------- `draft` `optional` @@ -68,7 +68,7 @@ For example: `/` -> `/index.html` or `/blog/` -> `/blog/index.html` Once the host server has found the `34128` event for the pubkey and path it should use the sha256 hash defined in the `x` tag to retrieve the file If the pubkey has a `10063` [BUD-03 user servers](https://github.com/hzrd149/blossom/blob/master/buds/03.md) event the server MUST attempt to retrieve the file from the listed servers using the path defined in [BUD-01](https://github.com/hzrd149/blossom/blob/master/buds/01.md#get-sha256---get-blob) -If a pubkey does not have a `10063` event the host server may choose to fallback to a predefined list of Blossom servers +If a pubkey does not have a `10063` event the host server MUST respond with a status code 404 The host server MUST forward the `Content-Type`, and `Content-Length` header from the Blossom server. If none are defined the host server MAY set `Content-Type` from the file extension in the requested path From 7084574a79d1d765bd366a2c7f7c854d383ec134 Mon Sep 17 00:00:00 2001 From: hzrd149 Date: Sat, 26 Oct 2024 10:15:58 +0100 Subject: [PATCH 3/4] fix some wording --- nsite.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nsite.md b/nsite.md index 852446b9..e76335fe 100644 --- a/nsite.md +++ b/nsite.md @@ -46,7 +46,7 @@ example Host: npub10phxfsms72rhafrklqdyhempujs9h67nye0p67qe424dyvcx0dkqgvap0e.nsite-host.com ``` -If the requests `Host` does not have a subdomain server MUST lookup any `CNAME` or `TXT` DNS records for the domain and attempt to resolve the pubkey from them +If the requests `Host` does not contain an `npub` the server MUST lookup any `CNAME` or `TXT` DNS records for the `Host` and attempt to resolve the pubkey from them The host server MAY serve anything at its own root domain `nsite-host.com` ( a landing page for example ) @@ -70,7 +70,7 @@ Once the host server has found the `34128` event for the pubkey and path it shou If the pubkey has a `10063` [BUD-03 user servers](https://github.com/hzrd149/blossom/blob/master/buds/03.md) event the server MUST attempt to retrieve the file from the listed servers using the path defined in [BUD-01](https://github.com/hzrd149/blossom/blob/master/buds/01.md#get-sha256---get-blob) If a pubkey does not have a `10063` event the host server MUST respond with a status code 404 -The host server MUST forward the `Content-Type`, and `Content-Length` header from the Blossom server. If none are defined the host server MAY set `Content-Type` from the file extension in the requested path +The host server MUST forward the `Content-Type`, and `Content-Length` headers from the Blossom server. If none are defined the host server MAY set `Content-Type` from the file extension in the requested path #### Handling Not Found From 41e77b45a1e8a8d170097e363f7d7254797cc5c5 Mon Sep 17 00:00:00 2001 From: hzrd149 Date: Mon, 20 Jan 2025 15:45:59 -0600 Subject: [PATCH 4/4] remove requirements for resolving pubkeys --- nsite.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/nsite.md b/nsite.md index e76335fe..44094741 100644 --- a/nsite.md +++ b/nsite.md @@ -1,8 +1,8 @@ NIP-XX ====== -Static Websites ---------------- +Pubkey Static Websites +---------------------- `draft` `optional` @@ -17,7 +17,7 @@ The `x` tag MUST be the sha256 hash of the file that will be served under this p For example: -```json +```jsonc { "content": "", "created_at": 1727373475, @@ -26,7 +26,9 @@ For example: "pubkey": "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5", "sig": "f4e4a9e785f70e9fcaa855d769438fea10781e84cd889e3fcb823774f83d094cf2c05d5a3ac4aebc1227a4ebc3d56867286c15a6df92d55045658bb428fd5fb5", "tags": [ + // absolute path for the file ["d", "/index.html"], + // sha256 hash of the file to be served ["x", "186ea5fd14e88fd1ac49351759e7ab906fa94892002b60bf7f5a428f28ca1c99"] ] } @@ -34,29 +36,25 @@ For example: ### Host server implementation -A host server is an http server that is responsible for serving the static files for pubkeys +A host server is a HTTP server that is responsible for serving pubkey static websites #### Resolving Pubkeys -When a request is made to the host server with a subdomain of a `npub`, the server MUST use it as the pubkey when searching for the static file +Host servers may choose to resolve a pubkey however they see fit, NIP-05 ids, `npub` subdomains, hardcoded names, DNS records, or a single pubkey for the server -example +However it is recommended to resolve pubkeys using a NIP-19 encoded pubkey `npub1...` as the subdomain. since this allows the host server to serve all pubkey sites while still keeping the pubkey in the URL -``` -Host: npub10phxfsms72rhafrklqdyhempujs9h67nye0p67qe424dyvcx0dkqgvap0e.nsite-host.com -``` +If the host server is using `npub` subdomains it MAY serve anything at its own root domain `nsite-host.com` ( a landing page for example ) -If the requests `Host` does not contain an `npub` the server MUST lookup any `CNAME` or `TXT` DNS records for the `Host` and attempt to resolve the pubkey from them - -The host server MAY serve anything at its own root domain `nsite-host.com` ( a landing page for example ) +Example subdomain `npub10phxfsms72rhafrklqdyhempujs9h67nye0p67qe424dyvcx0dkqgvap0e.npub-sites.com` #### Resolving Paths When the host server receives a request and is able to determine the pubkey. it should fetch the users `10002` [NIP-65](https://github.com/nostr-protocol/nips/blob/master/65.md) relay list and lookup `34128` events with a `d` tag matching the requested path -```json +```jsonc // For /index.html -{ "kinds": [34128], "authors": [pubkey], "#d": ["/index.html"] } +{ "kinds": [34128], "authors": [], "#d": ["/index.html"] } ``` If the request path does not end with a filename the host server MUST fallback to using the `index.html` filename