Skip to content

Commit a3ecdc9

Browse files
committed
Add a note about requiring the pg_trgm extension
1 parent a7e56b3 commit a3ecdc9

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/setup/database.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Database configuration
22

33
The service uses a [PostgreSQL](https://www.postgresql.org/) database to store all of its state.
4-
Although it may be possible to run with earlier versions, it is recommended to use **PostgreSQL 13** or later.
54
Connection to the database is configured in the [`database`](../reference/configuration.md#database) section of the configuration file.
65

76
## A warning about database pooling software
@@ -35,6 +34,18 @@ createdb --owner=mas_user mas
3534

3635
The above will create a user called `mas_user` with a password of your choice, and a database called `mas` owned by the `mas_user` user.
3736

37+
## Compatibility
38+
39+
Although it may be possible to run with earlier versions, it is recommended to use **PostgreSQL 13** or later.
40+
It requires the [`pg_trgm` extension](https://www.postgresql.org/docs/current/pgtrgm.html), which can be automatically enabled by the service on **PostgreSQL 16** or later, but may need to be enabled manually on older versions:
41+
42+
```sh
43+
# Connect to the MAS database as a user with superuser privileges
44+
$ psql mas
45+
mas=> CREATE EXTENSION IF NOT EXISTS pg_trgm;
46+
CREATE EXTENSION
47+
```
48+
3849
## Service configuration
3950

4051
Once the database is created, the service needs to be configured to connect to it.

0 commit comments

Comments
 (0)