https://github.com/nadiamoe/mastodon-api-proxy

https://github.com/nadiamoe/mastodon-api-proxy

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nadiamoe/mastodon-api-proxy
• Owner: nadiamoe
• License: agpl-3.0
• Created: 2024-03-02T18:26:47.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-12-15T16:24:48.000Z (21 days ago)
• Last Synced: 2024-12-27T05:04:25.701Z (9 days ago)
• Language: Go
• Homepage:
• Size: 61.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# `mastodon-api-proxy`

A proxy to Mastodon API that adds a `fake_email` field to the [`Account`](https://docs.joinmastodon.org/entities/Account/) object returned by [`verify_credentials`](https://docs.joinmastodon.org/methods/accounts/#verify_credentials).

Every other response, even `Account` responses from other endpoints, are left untouched.

## Usage

Run the container. `BACKEND_URL` is expected to point to the real mastodon URL. `DOMAIN` is the email domain used to form `fake_email`, in the form of `{acct}@{DOMAIN}`, where `acct` is the `acct` field returned by Mastodon.

`MIN_AGE` allows defining a minimum *account* age (time since the account was created, not the age of the person using the account). If defined, requests to `verify_credentials` for accounts below the minimum age will return `403 Forbidden`.

`MAX_STATUS_AGE` allows defining a maximum tolerable time for the account's last post. If defined, requests to `verify_credentials` for accounts whose last post is older than the specified value will return `403 Forbidden`.

## Why?

https://github.com/requarks/wiki/discussions/7037

### So how do I use this with wiki.js?

On wiki.js:

- Use your usual mastodon url for `Authorization Endpoint URL`, e.g. `https://your.instance/oauth/authorize`

- Use your usual mastodon url for `Token Endpoint URL`, e.g. `https://your.instance/oauth/token`

- Use the URL of this thing for `User info Endpoint URL`, e.g. `https://api-proxy.your.instance/api/v1/accounts/verify_credentials`. It must be an https URL or mastodon will attempt to redirect it to https.

- As `ID Claim`, `Display Name Claim` and `Email Claim` use `id`, `display_name` and `fake_email` respectively. `fake_email` is what this proxy adds.

On your mastodon instance:

- Add the domain where this thing listens (e.g. `api-proxy.your.instance`) to the `ALTERNATE_DOMAINS` environment variable for mastodon-web.

And you're good to go!