Skip to content

Commit a15bdd0

Browse files
committed
docs: add PostgreSQL 12→18 breaking change notice and link from Docker page
1 parent 573b254 commit a15bdd0

File tree

5 files changed

+49
-2
lines changed

5 files changed

+49
-2
lines changed

content/docs/install/docker.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,11 @@ The next step is to learn how to use LogChimp.
8787

8888
- LogChimp Docker images:
8989
- APIs - [link](https://github.com/orgs/logchimp/packages/container/package/logchimp%2Fapi)
90-
- Theme - [link](https://github.com/orgs/logchimp/packages/container/package/logchimp%2Ftheme)
90+
- Theme - [link](https://github.com/orgs/logchimp/packages/container/package/logchimp%2Ftheme)
91+
92+
<Alert type="warning">
93+
⚠️ **Breaking Change (PostgreSQL 12 → 18)**
94+
LogChimp now uses PostgreSQL 18 which introduces an incompatible data directory structure.
95+
Existing Docker volumes or databases from PostgreSQL 12 **will not work directly** with this version.
96+
Please review the [Breaking Change – PostgreSQL 12 → 18](/docs/miscellaneous/breaking-changes-pg18) page before upgrading or deploying.
97+
</Alert>

content/docs/install/railway.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ There are many ways to [install LogChimp](/docs/install/getting-started). With R
1313
notifications and more.
1414
</Alert>
1515

16+
<Alert type="warning">
17+
⚠️ **Breaking Change (PostgreSQL 12 → 18)**
18+
LogChimp now uses PostgreSQL 18 which introduces an incompatible data directory structure.
19+
Existing Docker volumes or databases from PostgreSQL 12 **will not work directly** with this version.
20+
Please review the [Breaking Change – PostgreSQL 12 → 18](/docs/miscellaneous/breaking-changes-pg18) page before upgrading or deploying.
21+
</Alert>
22+
1623
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/3Bm-Un?referralCode=mittalyashu)
1724

1825
All the environment variables are pre-configured for you. You can learn more about them [here](/docs/environment-variables).

content/docs/install/render.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ Clicking the "Deploy to Render" button will redirect you to the Render blueprint
1313
notifications and more.
1414
</Alert>
1515

16+
<Alert type="warning">
17+
⚠️ **Breaking Change (PostgreSQL 12 → 18)**
18+
LogChimp now uses PostgreSQL 18 which introduces an incompatible data directory structure.
19+
Existing Docker volumes or databases from PostgreSQL 12 **will not work directly** with this version.
20+
Please review the [Breaking Change – PostgreSQL 12 → 18](/docs/miscellaneous/breaking-changes-pg18) page before upgrading or deploying.
21+
</Alert>
22+
1623
All the environment variables are pre-configured for you. You can learn more about them [here](/docs/environment-variables).
1724

1825
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/logchimp/deploy-buttons)

content/docs/meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
"---Miscellaneous---",
1414
"[HandHelping][Contributing](https://github.com/logchimp/logchimp/blob/master/CONTRIBUTING.md)",
1515
"miscellaneous/faq",
16-
"miscellaneous/security-policy"
16+
"miscellaneous/security-policy",
17+
"miscellaneous/breaking-changes-pg18"
1718
],
1819
"defaultOpen": true
1920
}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Breaking Changes: PostgreSQL 12 → 18
2+
3+
<Alert type="warning">
4+
⚠️ **Important Notice:**
5+
Upgrading to PostgreSQL 18 introduces a new cluster storage layout that is **not compatible** with PostgreSQL 12.
6+
Existing Docker volumes or data directories from v12 **will fail to start** unless properly migrated.
7+
Please back up your data and follow the steps below before proceeding with any upgrade.
8+
</Alert>
9+
10+
## Summary
11+
PostgreSQL 18 introduces a new cluster storage layout incompatible with version 12.
12+
13+
## Impact
14+
- Existing Docker volumes from v12 will fail to mount directly.
15+
- `pg_upgrade` or data export/import is required.
16+
- Environment variables and data paths differ (`/var/lib/postgresql/18/data`).
17+
18+
## Recommended Action
19+
1. Backup all data from v12.
20+
2. Use the official upgrade container or `pg_upgrade`.
21+
3. Verify compatibility in staging before production rollout.
22+
23+
## References
24+
- [PostgreSQL Docker Migration Notes](https://github.com/docker-library/postgres/pull/1259)
25+
- [Official PostgreSQL Upgrade Guide](https://www.postgresql.org/docs/18/pgupgrade.html)

0 commit comments

Comments
 (0)