This content originally appeared on Phil Nash and was authored by Phil Nash
Mastodon is different to most online services. Because it is a federated network, when you set up an account you need to choose a server to use. Your username then becomes a combination of your handle and that server you signed up to. For example, I am currently @philnash@mastodon.social.
But what if you want to personalise that a bit more? What if you wanted to use your own domain for your Mastodon account without having to host a whole Mastodon server? Using your own domain means that no matter what instance you used, or if you moved instance, you could share one Mastodon username that always pointed to the right profile and was personalised to your own site.
WebFinger to the rescue
It turns out that you can do this. Maarten Balliauw wrote about how Mastodon uses WebFinger to attach extra information to an email address. Information like an associated profile page or ActivityPub stream.
Implementing WebFinger requires your domain to respond to a request to /.well-known/webfinger with a JSON representation of the associated accounts. If you have a Mastodon account you can check out what your WebFinger JSON looks like by making a request to https://#{instance}/.well-known/webfinger?resource=acct:#{username}@#{instance}. For example, my WebFinger JSON is available at this URL: https://mastodon.social/.well-known/webfinger?resource=acct:philnash@mastodon.social.
To associate a Mastodon account with your own domain, you can serve this JSON yourself from a /.well-known/webfinger endpoint.
WebFinger with Jekyll
As Maarten pointed out in his post, you can copy the JSON response from your Mastodon instance to a file that you then serve from your own site. My site is powered by Jekyll, so I wanted to make it easy for me, and anyone else using Jekyll, to create and serve that WebFinger JSON. I’ve also built Jekyll plugins before, like jekyll-gzip, jekyll-brotli, jekyll-zopfli, and jekyll-web_monetization.
I got to work and built jekyll-mastodon_webfinger.
How to use it
You can serve up your own WebFinger JSON on your Jekyll site to point to your Mastodon profile by following these steps:
-
Add
jekyll-mastodon_webfingerto your Gemfile:bundle add jekyll-mastodon_webfinger -
Add the plugin to your list of plugins in
_config.yml:plugins: - jekyll/mastodon_webfinger -
Add your Mastodon username and instance to
_config.yml:mastodon: username: philnash instance: mastodon.social
Next time you build the site, you will find a /.well-known/webfinger file in your output directory, and when you deploy you will be able to refer to your Mastodon account using your onw domain.
You can see the result of this by checking the WebFinger endpoint on my domain: https://philna.sh/.well-known/webfinger or by searching for @phil@philna.sh on your Mastodon instance.
As this is a static file it sort of acts like a catch-all email address. You can actually search for @any_username@philna.sh and you will find me. If you wanted to restrict this, you would need to build an endpoint that could respond dynamically to the request.
Other ways to serve Mastodon WebFinger responses
I’m not the only one to have considered this. Along with Maarten’s original post on the topic, others have built tools or posted about how to do this with your own site.
Lindsay Wardell wrote up how to integrate Mastodon with Astro including showing how to display her feed within her Astro site.
Dominik Kundel put together a Netlify plugin that generates a Mastodon WebFinger file for your Netlify hosted site.
Take a trip into the Fediverse
An interesting side-effect of the increase in popularity of Mastodon is learning and understanding the protocols that underpin federating a social network like this. WebFinger and ActivityPub are having their moment and I look forward to see what further integrations and applications can be built on top of them.
In the meantime, you can use the techniques in this post to use your own domain as an alias for your Mastodon profile. And if you fancy it, connect with me on Mastodon by searching for @phil@philna.sh or at https://mastodon.social/@philnash.
This content originally appeared on Phil Nash and was authored by Phil Nash
Phil Nash | Sciencx (2022-11-23T00:00:00+00:00) Alias your Mastodon username to your own domain with Jekyll. Retrieved from https://www.scien.cx/2022/11/23/alias-your-mastodon-username-to-your-own-domain-with-jekyll/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.