Skip to content

feat: Add caution about postgres scheme designator in self hosted doc #991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2025
Merged

feat: Add caution about postgres scheme designator in self hosted doc #991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/deployment/self-host-supertokens.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,10 @@ You also need to make the database listen on all the IPs of the local machine.
Edit the `postgresql.conf` configuration file and set the value of `listen_addresses` to `0.0.0.0`.
:::

:::caution
It is important to use the `postgresql://` scheme designator in the PostgreSQL Connection URI. Using `postgres://` will lead to a startup error.
:::

```bash

docker run \
Expand Down Expand Up @@ -358,6 +362,11 @@ mysql_database_name: "supertokens"
</DatabaseTabs.TabItem>

<DatabaseTabs.TabItem value="postgresql">

:::caution
It is important to use the `postgresql://` scheme designator in the PostgreSQL Connection URI. Using `postgres://` will lead to a startup error.
:::

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command
Expand Down