A functional guide for Handshake users

Yeil DNS

Host a free static site on GitHub Pages and point your Handshake name to it with Yeil DNS, which manages your records without taking custody of your name.

How to Host an HTTP website on a Handshake TLD

Note: Yeil DNS is a DNS hosting service that lets you manage your name records from a self-custodial wallet (one TLD free; unlimited for $12/year). This guide uses Bob, but Namebase Wallet, from the same team behind Yeil, is another great option that can be used, and I encourage you to try too.

0. What you need

1. Wallet with a TLD and some coins

You'll need a TLD held in your own Bob Wallet or Namebase Wallet, plus a small amount of HNS (10 HNS is more than enough). If you're new to Handshake, you can get some HNS from the faucet.

Once you have some HNS, you can bid on TLDs in name auctions using Bob or Namebase. Both are self-custodial wallets that let you take part in the auctions directly.

2. Yeil DNS account

Yeil DNS is a service that lets you point your self-custodied TLD to its nameservers, so you can manage your domain records without giving up custody of your TLD. At any time, you can use your wallet to remove the records that point your TLD to Yeil, ending the connection. Yeil is developed by eskimo.

3. Connect your domain: Bob Wallet ↔ Yeil

You need to connect your TLD (in your wallet) to Yeil DNS. In your Yeil account, go to New zone, type the TLD name you own, and click Add. Once created it will appear the records you need to add to your TLD in Bob Wallet in order to create the connection.

πŸ¦β€β¬› Yeil DNS: records for your zone

In Bob Wallet, go to Domain Manager and click your TLD to open a new screen. In the Records section, add the records provided by Yeil:

πŸˆβ€β¬› Bob Wallet: Domain Manager

Click Submit to save the changes. Updating takes roughly 10–20 minutes (the time for each block to be minted). After that, you should be able to see the new records on any HNS explorer, such as Shakeshift.

4. Configure GitHub

Create a New repository, give it a name of your choice, and click Create.

In your new repository, click Add file β†’ Create new file. Name the file index.html and add some HTML content in the editor, for example:

<h1>Hi, it's me!</h1>

Commit the changes.

Still on GitHub, open the Settings tab and scroll down to the Pages section. Set the source to the main branch and the / (root) folder, then click Save. After about 5 minutes, refresh the Pages section, a message at the top will show that your site is live at a URL similar to:

https://youraccount.github.io/yourrepository

Visit the site. At this point, your website is online.

In the Pages section, go to Custom domain and add your desired domain. Note that GitHub will not recognize a pure HNS top-level domain (e.g. http://yourdomain), it must be a second-level domain, such as:

hi.yourdomain

Because it is not an ICANN domain, GitHub will report that it doesn't work. Even though it will always show "DNS Check in Progress," your site will still be online. It takes around 30 minutes to go live.

🐈 GitHub: Pages settings

5. Set your domain: Yeil ↔ GitHub

Finally, connect Yeil with GitHub. In your Yeil DNS zone, click New record for your domain and add an A record:

TypeNameIPv4 address
Ahi.yourdomain185.199.111.153 (a GitHub Pages IP)
πŸ¦β€β¬› Yeil DNS: new A record

The record update takes about 6 hours to go live. After that, your site will be online at your domain πŸŽ‰:

http://hi.yourdomain/

6. Keep your repository private with Vercel

This last step is optional, and requires a free Vercel account. It's for when you want your site to stay online over HTTP while keeping its GitHub repository private. On GitHub's free plan, GitHub Pages only works with public repositories. If you make your repository private, your site goes offline. Vercel solves this: it reads your repository directly (even a private one) and serves the site itself, so the code can stay private while the site stays online.

How it works, in short: you connect GitHub to Vercel, import your website repository, add your domain in Vercel, and then add the DNS records Vercel gives you on Yeil DNS. From then on, Vercel serves your site. Each time you push changes to GitHub, Vercel updates the site automatically.

β–² Deploying your site on Vercel

Tip: if your site is plain HTML (no build tools), set Framework Preset to Other when importing. If you later see a 404: NOT_FOUND page, go to Settings β†’ Build & Deployment, set the Output Directory to . (a single dot), and redeploy.