Skip to content

Commit 103d229

Browse files
committed
update docs to mention postgres db changes
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
1 parent c6c6250 commit 103d229

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

docs/development/docker.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Run a server using Docker
22

3+
## PostgreSQL versions
4+
5+
At times we will update the Docker configurations to use a newer version of
6+
PostgreSQL. Often, the newer version will be incompatible with the existing
7+
database, and you will need to create a new database.
8+
9+
For example between releases `0.5.4` and `0.6.0` I updated the docker config to
10+
use PostgreSQL **17** instead of **15**. In this case the existing database was
11+
not compatible.
12+
13+
You have 3 options in this case:
14+
15+
1. delete the docker volume `api-db-data` and just start again. This is fine if
16+
you are only using docker for testing.
17+
2. change the `docker-compose.yml` to use the previous version of PostgreSQL
18+
instead. In the case of `0.6.0` you can change back to `15.6-bullseye`. This
19+
is on line **25** (as of version `0.6.0` anyway).
20+
3. log into the docker instance and migrate the data to version 17. There are
21+
several guides for this if you search.
22+
323
## Run a Server
424

525
Docker containers can be used for testing the API during development just make

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ lint.help = "Run all linting checks"
114114
"docs:publish".help = "Publish documentation to GitHub Pages"
115115
"docs:build".cmd = "mkdocs build"
116116
"docs:build".help = "Build documentation locally to './site' folder"
117-
"docs:serve".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md -w BUGS.md"
117+
"docs:serve".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md"
118118
"docs:serve".help = "Serve documentation locally"
119-
"docs:serve:all".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md -w BUGS.md -a 0.0.0.0:8000"
119+
"docs:serve:all".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md -a 0.0.0.0:8000"
120120
"docs:serve:all".help = "Serve documentation locally on all interfaces"
121121

122122
# regenerate the openapi.json file

0 commit comments

Comments
 (0)