docs: Add note on backing up the docker database

I'm sick of waiting for 'parsearchive' to finish.

Signed-off-by: Stephen Finucane <stephen@that.guru>

diff --git a/docs/development/installation.rst b/docs/development/installation.rst
index 90c07b5b0c124ed3640c7898e9f8677b2f91bb5f..f77147d839ffee93f2f498427280b0bdeda21f85 100644 (file)
--- a/docs/development/installation.rst
+++ b/docs/development/installation.rst
@@ -96,8 +96,17 @@ run:
        -v /tmp/.X11-unix:/tmp/.X11-unix \
        -e PW_TEST_DB_HOST=db -e DISPLAY patchwork_web bash
 
-To reset the database before any of these commands, add `--reset` to the
-command line after `web` and before any other arguments.
+To reset the database before any of these commands, add ``--reset`` to the
+command line after ``web`` and before any other arguments. Conversely, to
+backup the database at any stage, run:
+
+.. code-block:: shell
+
+    $ docker exec DATABASECONTAINER /usr/bin/mysqldump -u DATABASEUSER \
+        --password=DATABASEPASSWORD DATABASE > backup.sql
+
+where ``DATABASECONTAINER`` is found by ``docker ps -a`` and the other settings
+are the same as those defined in ``patchwork/settings/dev.py``.
 
 Any local edits to the project files made locally are immediately visible to
 the Docker container, and so should be picked up by the Django auto-reloader.