🐘
PostgreSQL
When using the PostgreSQL app driver, first configure your PostgreSQL connection credentials using environment variables:
Name
Default
Possible values
Description
DB_POSTGRES_HOST
127.0.0.1
Any string
The PostgreSQL host.
DB_POSTGRES_PORT
3306
Any integer
The PostgreSQL port.
DB_POSTGRES_USERNAME
root
Any string
The PostgreSQL username.
DB_POSTGRES_PASSWORD
password
Any string
The PostgreSQL password.
DB_POSTGRES_DATABASE
main
Any string
The PostgreSQL database.
This database supports database connection pooling.
Once you have configured your PostgreSQL database credentials, you should create a table with the following structure:
1
CREATE TABLE IF NOT EXISTS apps (
2
id varchar(255) PRIMARY KEY,
3
"key" varchar(255) NOT NULL,
4
secret varchar(255) NOT NULL,
5
max_connections integer NOT NULL,
6
enable_client_messages smallint NOT NULL,
7
"enabled" smallint NOT NULL,
8
max_backend_events_per_sec integer NOT NULL,
9
max_client_events_per_sec integer NOT NULL,
10
max_read_req_per_sec integer NOT NULL,
11
webhooks json
12
);
Copied!

Environment Variables

The following environment variables are used to define the behavior of the PostgreSQL app driver:
Name
Default
Possible values
Description
APP_MANAGER_POSTGRES_TABLE
apps
Any string
The table to pull the app data from.
APP_MANAGER_POSTGRES_VERSION
13.3
Any string
The PostgreSQL version (utilized by the underlying Knex database abstraction layer).

Limits on an app-by-app basis

This feature is truly optional. To enforce app-level limits in PostgreSQL, you should add the following fields to your table:
1
max_presence_members_per_channel integer DEFAULT NULL,
2
max_presence_member_size_in_kb integer DEFAULT NULL,
3
max_channel_name_length integer DEFAULT NULL,
4
max_event_channels_at_once integer DEFAULT NULL,
5
max_event_name_length integer DEFAULT NULL,
6
max_event_payload_in_kb integer DEFAULT NULL,
7
max_event_batch_size integer DEFAULT NULL
Copied!
Setting any of them to null or '' will ignore the setting, and use the limits associated with the server-level declared defaults.
Existing apps running on <0.29.0 will still work even if you don't have these fields added after the migration to 0.29.0. You should add these fields to keep your database up-to-date or to have the choice to, later on, imply limits to your apps.