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.

Warning: With the actual implementation of the OIDC provider, GitHub / Google login provider will be disabled.
If you want to use OAuth/OIDC, please follow the instructions below. We will use Authentik as an OIDC provider example, with base URL https://authentik.example.com
1

Create an Application/Provider on the Authentik side

You will find the following important information:
  • redirect_uri => https://postiz.yourserver.com/settings
  • client_id => randomclientid
  • client_secret => randomclientsecret
  • auth_url => https://authentik.example.com/application/o/authorize
  • token_url => https://authentik.example.com/application/o/token
  • userinfo_url=> https://authentik.example.com/application/o/userinfo
The same information needs to be configured on other OIDC providers such as Keycloak, Dex, etc.
2

Configure POSTIZ_GENERIC_OAUTH

POSTIZ_GENERIC_OAUTH="true"
Set to true to enable OIDC login.
3

Configure display name

NEXT_PUBLIC_POSTIZ_OAUTH_DISPLAY_NAME="Authentik"
Will display the name of the OIDC provider on the login page.
4

Configure logo URL

NEXT_PUBLIC_POSTIZ_OAUTH_LOGO_URL="https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/authentik.png"
Will display the logo of the OIDC provider on the login page button.
5

Configure POSTIZ_OAUTH_URL

POSTIZ_OAUTH_URL="https://authentik.example.com"
The base URL of the OIDC provider.
6

Configure POSTIZ_OAUTH_AUTH_URL

POSTIZ_OAUTH_AUTH_URL="https://authentik.example.com/application/o/authorize/"
The authorization URL of the OIDC provider.
7

Configure POSTIZ_OAUTH_TOKEN_URL

POSTIZ_OAUTH_TOKEN_URL="https://authentik.example.com/application/o/token/"
The token URL of the OIDC provider.
8

Configure POSTIZ_OAUTH_USERINFO_URL

POSTIZ_OAUTH_USERINFO_URL="https://authentik.example.com/application/o/userinfo/"
The userinfo URL of the OIDC provider.
9

Configure POSTIZ_OAUTH_CLIENT_ID

POSTIZ_OAUTH_CLIENT_ID="randomclientid"
The client ID of the OIDC provider.
10

Configure POSTIZ_OAUTH_CLIENT_SECRET

POSTIZ_OAUTH_CLIENT_SECRET="randomclientsecret"
The client secret of the OIDC provider.