From d746348ea68fdd9e2315aad96eeccbef311d220e Mon Sep 17 00:00:00 2001 From: Lars Eggert Date: Wed, 13 Oct 2021 14:21:42 +0000 Subject: [PATCH] More explanations - Legacy-Id: 19419 --- docker/README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/docker/README.md b/docker/README.md index 19d363058..fe5c9fff4 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,5 +1,7 @@ # Datatracker Development in Docker +## Getting started + 1. [Set up Docker](https://docs.docker.com/get-started/) on your preferred platform. @@ -12,11 +14,13 @@ svn co https://svn.ietf.org/svn/tools/ietfdb/trunk cd trunk -3. **TEMPORARY:** Replace the contents of the `docker` directory with Lars' - files. +3. **TEMPORARY:** Replace the contents of the `docker` directory with [Lars' + files](https://svn.ietf.org/svn/tools/ietfdb/personal/lars/7.39.1.dev0/docker/). -4. **TEMPORARY:** Until Lars' changes have been merged and a docker image is - available for download, you will need to build it locally: +4. **TEMPORARY:** Until [Lars' + changes](https://svn.ietf.org/svn/tools/ietfdb/personal/lars/7.39.1.dev0/docker/) + have been merged and a docker image is available for download, you will need + to build it locally: docker/build @@ -24,14 +28,29 @@ 5. Use the `docker/run` script to start the datatracker container. You will be dropped into a shell from which you can start the datatracker and execute - related commands as usual, for example: + related commands as usual, for example ietf/manage.py runserver 0.0.0.0:8000 + to start the datatracker. + + You can also pass additional arguments to `docker/run`, in which case they + will be executed in the container (instead of a shell being started.) + If you do not already have a copy of the IETF database available in the `data` directory, one will be downloaded and imported the first time you run `docker/run`. This will take some time. Once the datatracker has started, you should be able to open [http://localhost:8000](http://localhost:8000) in a browser and see the - landing page. \ No newline at end of file + landing page. + +## Troubleshooting + +- If the database fails to start, the cause is usually an incompatibility + between the database that last touched the files in `data/mysql` and the + database running inside the docker container. + + The solution is to blow away your existing database (`rm -rf data/mysql`). A + fresh copy will be retrieved and imported next time you do `docker/run`, which + should resolve this issue. \ No newline at end of file