From 09172068277d80d50fdbaf889e8f2fc24320cb60 Mon Sep 17 00:00:00 2001 From: Jeremiah Rose Date: Wed, 8 Sep 2021 10:20:24 +1000 Subject: [PATCH] Update Dockerfile.build documentation in DEPLOYMENT.rst --- doc/DEPLOYMENT.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/doc/DEPLOYMENT.rst b/doc/DEPLOYMENT.rst index ab0f0176..a7499d19 100644 --- a/doc/DEPLOYMENT.rst +++ b/doc/DEPLOYMENT.rst @@ -184,13 +184,24 @@ Dockerfile for building from source We provide ``Dockerfile.build`` to automatically build ``libstt.so``, the C++ native client, Python bindings, and KenLM. -If you want to specify a different repository or branch, you can specify the ``STT_REPO`` or ``STT_SHA`` arguments: +Before building, make sure that git submodules have been initialised: .. code-block:: bash - docker build . -f Dockerfile.build --build-arg STT_REPO=git://your/fork --build-arg STT_SHA=origin/your-branch + git submodule sync + git submodule update --init + +Then build with: -.. _runtime-deps: +.. code-block:: bash + + docker build . -f Dockerfile.build -t stt-image + +You can then use stt inside the Docker container: + +.. code-block:: bash + + docker run -it stt-image bash Runtime Dependencies