add database upgrade instructions
This commit is contained in:
14
README.md
14
README.md
@ -74,6 +74,20 @@ You can use the following environment variables to configure Cannery in
|
||||
`no-reply@HOST` where `HOST` was previously defined.
|
||||
- `EMAIL_NAME`: Sets the sender name in sent emails. Defaults to "Cannery".
|
||||
|
||||
# Upgrading the Database
|
||||
|
||||
Typically, PostgreSQL updates can improve the performance of the database, and
|
||||
the cannery app. However, these require some additional maintenance. While the
|
||||
typical method is to manually dump and restore the database using the `pg_dump`
|
||||
tool, I recommend using the
|
||||
[pgautoupgrade tool](https://github.com/pgautoupgrade/docker-pgautoupgrade),
|
||||
which can perform this for you automatically. In the `docker-compose.yml` file,
|
||||
you can do this easily by switching the `image:` value from for example,
|
||||
`postgres:13` to `pgautoupgrade/pgautoupgrade:17-alpine` and rerun
|
||||
`docker-compose up -d`. This will automatically migrate your database to
|
||||
Postgres 17, and then you can switch back to the original `postgres:17` image
|
||||
for additional performance, or keep using the upgrade image if you'd like.
|
||||
|
||||
# Contribution
|
||||
|
||||
Contributions are greatly appreciated, no ability to code needed! You can browse
|
||||
|
@ -32,7 +32,12 @@ services:
|
||||
- cannery-db
|
||||
|
||||
cannery-db:
|
||||
image: postgres:13
|
||||
image: postgres:17
|
||||
# To upgrade your database from a previous version, replace the existing
|
||||
# image with the following line. Once the container has been booted and your
|
||||
# database updated, you can revert back to the original `postgres:17` image
|
||||
# if you'd like
|
||||
# image: pgautoupgrade/pgautoupgrade:17-alpine
|
||||
container_name: cannery-db
|
||||
environment:
|
||||
- POSTGRES_USER="postgres"
|
||||
|
Reference in New Issue
Block a user