Uploading Pool Metadata to GitHub Pages

To host the file containing metadata for your pool on GitHub Pages:

  1. Sign up or login to your GitHub account.

  2. Create a new public repository named username.github.io, where username is your username (or organization name) on GitHub. Shorter the better.

  1. Click Get started by "creating a new file" under Quick setup.

  2. Enter your file name as md.json and paste in your JSON content.

  1. Click Commit Changes...

  1. If everything worked properly, your pool metadata is now hosted at URL:


Ensure the URL is less than 64 characters. If too long, pick a shorter github username or shorter json file name.

  1. In your stakepool registration transaction, set the value of the --metadata-url parameter to this URL.

  2. On your block producer node, download your JSON file using the URL with wget command:

wget -O md.json <your github pages URL>

Note that it can take up to 10 minutes for changes to your site to publish after you commit changes.

  1. As a sanity check, check the contents of your JSON file.

cat md.json
  1. On your block producer node, generate the updated pool metadata hash.

cardano-cli stake-pool metadata-hash --pool-metadata-file md.json > poolMetaDataHash.txt

Last updated