Skip to content

Commit d746348

Browse files
committed
More explanations
- Legacy-Id: 19419
1 parent c4ba1ea commit d746348

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

docker/README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Datatracker Development in Docker
22

3+
## Getting started
4+
35
1. [Set up Docker](https://docs.docker.com/get-started/) on your preferred
46
platform.
57

@@ -12,26 +14,43 @@
1214
svn co https://svn.ietf.org/svn/tools/ietfdb/trunk
1315
cd trunk
1416

15-
3. **TEMPORARY:** Replace the contents of the `docker` directory with Lars'
16-
files.
17+
3. **TEMPORARY:** Replace the contents of the `docker` directory with [Lars'
18+
files](https://svn.ietf.org/svn/tools/ietfdb/personal/lars/7.39.1.dev0/docker/).
1719

18-
4. **TEMPORARY:** Until Lars' changes have been merged and a docker image is
19-
available for download, you will need to build it locally:
20+
4. **TEMPORARY:** Until [Lars'
21+
changes](https://svn.ietf.org/svn/tools/ietfdb/personal/lars/7.39.1.dev0/docker/)
22+
have been merged and a docker image is available for download, you will need
23+
to build it locally:
2024

2125
docker/build
2226

2327
This will take a while, but only needs to be done once.
2428

2529
5. Use the `docker/run` script to start the datatracker container. You will be
2630
dropped into a shell from which you can start the datatracker and execute
27-
related commands as usual, for example:
31+
related commands as usual, for example
2832

2933
ietf/manage.py runserver 0.0.0.0:8000
3034

35+
to start the datatracker.
36+
37+
You can also pass additional arguments to `docker/run`, in which case they
38+
will be executed in the container (instead of a shell being started.)
39+
3140
If you do not already have a copy of the IETF database available in the
3241
`data` directory, one will be downloaded and imported the first time you run
3342
`docker/run`. This will take some time.
3443

3544
Once the datatracker has started, you should be able to open
3645
[http://localhost:8000](http://localhost:8000) in a browser and see the
37-
landing page.
46+
landing page.
47+
48+
## Troubleshooting
49+
50+
- If the database fails to start, the cause is usually an incompatibility
51+
between the database that last touched the files in `data/mysql` and the
52+
database running inside the docker container.
53+
54+
The solution is to blow away your existing database (`rm -rf data/mysql`). A
55+
fresh copy will be retrieved and imported next time you do `docker/run`, which
56+
should resolve this issue.

0 commit comments

Comments
 (0)