Configuration Reference

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.

At the moment, Postiz is entirely configured by environment variables. It is important to understand that any configuration change to environment variables will require an application restart. An example file of the most used configuration settings can be found here; example postiz.env file

​

Required Settings

​

DATABASE_URL

eg: postgresql://postiz-user:postiz-password@localhost:5432/postiz-db-local Postgres is not strictly necessary, Postiz uses Prisma to connect to the database, so technically mariadb or other databases could be used.

​

REDIS_URL

eg: redis://localhost:6379

​

JWT_SECRET

A random string that should be unique for every installation, this is used to secure your JWT auth tokens.

​

FRONTEND_URL

eg: http://postiz.example.lan:4200

​

NEXT_PUBLIC_BACKEND_URL

eg: http://postiz.example.lan:3000

​

BACKEND_INTERNAL_URL

If running everything in the same host/container: http://localhost:3000

​

Optional settings

Refer to the example postiz.env file for additional configuration options.

​

OAUTH

See this page for reference.

​

DISABLE_REGISTRATION

eg: true This will only allow a single user registration, and then after that the sign-up page will be disabled. Useful for self-hosting where you want complete control over users.

​

DISABLE_IMAGE_COMPRESSION

This will disable the image compression if set to “true”.

​

EXTENSION_ID

The Chrome Extension ID for cookie-based platform integrations (e.g., Skool). Required if you want to use platforms that don’t offer OAuth APIs. See the Chrome Extension guide for setup instructions.

​

Social Media keys

See the “providers” section of the documentation for the provider you want to configure, for details about how to set that up.