An extremely simple NIP-05 compliant server.
- Git
- Docker Engine
- Docker Compose
- Ports
80/tcpand443/tcpexposed/forwarded to the host- NOTE: if using a VPS, you usually don't need to do any port-forwarding
- DNS entries for your top-level domain pointing to your server's external IP address
This repo relies on Docker Compose to configure and run an nginx container serving nostr.json, leveraging Traefik to automatically expose it, request and maintain Let's Encrypt certificates for SSL, and handle all proxying.
You will need to clone this repository to the host you want running these services first:
git clone https://github.com/sethforprivacy/easy-nip05.git
cd easy-nip05Once cloned, set the email address and domain name to use in the docker-compose.yml file, replacing:
replace_with_working_email_addresswith an email address likeemail@email.comreplace_with_your_domainwith your domain, likesethforprivacy.com
Edit the nostr.json file, replacing:
YOUR_NOSTR_NAMEwith whatever name you prefer, such asseth- This name will be appended to your domain name (i.e.
seth@sethforprivacy.com), so usually best to keep it short and sweet - You can also set it to just
_and your NIP-05 verification will be just your domain (i.e.sethforprivacy.com). You would need to use_@domain.comfor your NIP05 config in your client.
- This name will be appended to your domain name (i.e.
YOUR_NOSTR_PUBLIC_KEY_IN_HEXwith your Nostr public key, in hex format, like58ead82fa15b550094f7f5fe4804e0fe75b779dbef2e9b20511eccd69e6d08f9
It should look like the following afterwards:
{
"names": {
"seth": "58ead82fa15b550094f7f5fe4804e0fe75b779dbef2e9b20511eccd69e6d08f9"
}
}Start-up the services with Docker Compose:
docker-compose up -d
You can verify that it's available at the full URL now, i.e https://sethforprivacy.com/.well-known/nostr.json. If that gives you the contents of your nostr.json file you edited earlier, it's working properly!
Now add the new NIP-05 identity to your Nostr profile, and you should have that fancy check-mark :)