https://github.com/pstadler/cloudflare-webfinger

Bring your own domain to Mastodon using Cloudflare Workers.
https://github.com/pstadler/cloudflare-webfinger

cloudflare cloudflare-workers mastodon webfinger

Last synced: 17 days ago
JSON representation

Bring your own domain to Mastodon using Cloudflare Workers.

• Host: GitHub
• URL: https://github.com/pstadler/cloudflare-webfinger
• Owner: pstadler
• License: mit
• Created: 2023-02-10T11:11:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-13T11:02:40.000Z (over 1 year ago)
• Last Synced: 2024-04-14T23:01:57.525Z (7 months ago)
• Topics: cloudflare, cloudflare-workers, mastodon, webfinger
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Custom Mastodon domain using Cloudflare Workers

> Use your own domain as an alias of your Mastodon handle.

When presented with a string like `[email protected]`, Mastodon clients use the WebFinger protocol to retrieve a JSON document pointing to resources related to this account.

We can make use of this by proxying requests to our own custom domain at `/.well-known/webfinger` to the actual Mastodon instance using Cloudflare Workers.

```mermaid

sequenceDiagram

  actor C as Client

  participant W as Cloudflare Worker

  participant M as Mastodon Instance

  C->>+W: GET https://pstadler.dev/.well-known/webfinger
?resource=acct:[email protected]

  Note over W: Find target for alias in mapping:
[email protected] → [email protected]

  W->>+M: GET https://infosec.exchange/.well-known/webfinger
?resource=acct:[email protected]

  M-->>-W: Response for [email protected]

  W-->>-C: Response for [email protected]

```

## Configuration

Configure your aliases at the top of `webfinger.js`. Multiple entries are supported.

```js

const MAPPING = new Map([

  ['[email protected]', '[email protected]'],

  ['[email protected]', '[email protected]']

])

```

## Testing

You can test this worker locally using [miniflare](https://miniflare.dev/).

```sh

$ npm install

$ npm run dev

$ curl http://127.0.0.1:8787\?resource\=acct:[email protected]

{"subject":"acct:[email protected]","aliases":["https://infosec.exchange/@ps","https://infosec.exchange/users/ps"],"links":[{"rel":"http://webfinger.net/rel/profile-page","type":"text/html","href":"https://infosec.exchange/@ps"},{"rel":"self","type":"application/activity+json","href":"https://infosec.exchange/users/ps"},{"rel":"http://ostatus.org/schema/1.0/subscribe","template":"https://infosec.exchange/authorize_interaction?uri={uri}"}]}

```

## Deployment

Change values in `wrangler.toml` according to your needs.

```sh

# Either make sure `wrangler` is available on your system, or run

# `npm install` and add `./node_modules/.bin` to your PATH variable.

$ wrangler login

$ wrangler publish

$ curl https://pstadler.dev/.well-known/webfinger\?resource\=acct:[email protected]

{"subject":"acct:[email protected]","aliases":["https://infosec.exchange/@ps","https://infosec.exchange/users/ps"],"links":[{"rel":"http://webfinger.net/rel/profile-page","type":"text/html","href":"https://infosec.exchange/@ps"},{"rel":"self","type":"application/activity+json","href":"https://infosec.exchange/users/ps"},{"rel":"http://ostatus.org/schema/1.0/subscribe","template":"https://infosec.exchange/authorize_interaction?uri={uri}"}]}

```

## Caveats

As of early 2023, some native Mastodon clients don't seem to make use of WebFinger when searching for users, which will result in your profile not being found with this approach.