Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.postiz.com/llms.txt

Use this file to discover all available pages before exploring further.

Watch the YouTube Tutorial: https://youtu.be/IAnfbE_htqg?si=z30m5qS8qLDN9R0X
Mastodon client registration is not done via the web interface, but by talking to the API directly. In the example below, we use curl to register a new client. Optionally check that you have jq installed on your system. You can normally install this with brew, apt-get, yum or chocolatey. If you don’t have jq installed, you can remove it from the command below.
The examples on this page use https://mastodon.social as the default Mastodon instance. If you are setting up Postiz to connect to a different self-hosted Mastodon instance (e.g., https://fosstodon.org), you must replace https://mastodon.social with your instance’s URL in the curl command below. You will also need to ensure the MASTODON_URL environment variable in your application’s .env file (or equivalent configuration for Docker, etc.) is set to your custom instance’s URL.
1

Register your client

Your Mastodon OAuth2 Redirect URI:
  • Production: https://your-postiz-domain.com/integrations/social/mastodon
  • Local development: http://localhost:4200/integrations/social/mastodon
  • Docker: http://localhost:5000/integrations/social/mastodon
Run the following curl command in a terminal to get the Mastodon client id and client secret.
curl -X POST -sS https://mastodon.social/api/v1/apps -F "client_name=YourAppName" -F "redirect_uris=http://localhost:4200/integrations/social/mastodon" -F "scopes=write:statuses write:media profile" | jq
This will give you output that looks something like this;
{
  "id": "1234567890",
  "redirect_uris": [
    "http://localhost:4200/integrations/social/mastodon"
  ],
  ...
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}
2

Add credentials to your environment

Make a note of your client_id and client_secret and add them to your .env file.
MASTODON_CLIENT_ID="shown in the output from the above command"
MASTODON_CLIENT_SECRET="shown in the output from the above command"
MASTODON_URL="https://mastodon.social" # Change this if connecting to a different instance
3

Start Postiz

Stop Postiz if it is running, and then start it using the .env file with the Mastodon details. Click through the new channel setup and you should be asked to login on Mastodon.

​
Troubleshooting

​
”Failed to fetch” / “fetch failed” when connecting

The Postiz backend needs network access to reach your Mastodon instance. If the connect call fails at this stage, the backend container couldn’t resolve or reach the MASTODON_URL host. Fix
  1. From inside the backend container, run curl -I https://your-instance.example.com/. If that fails, fix DNS/egress before retrying.
  2. If you’re behind a corporate proxy, set HTTPS_PROXY on the backend.
  3. Confirm MASTODON_URL exactly matches your instance — protocol included, no trailing slash issues.