Add documentation for running the app in a Docker image #9

Signed-off-by: Thomas Druez <tdruez@nexb.com>

CHANGELOG.rst

@@ -3,6 +3,9 @@
 
 ### v1.0.5 (unreleased)
 
+- Add support for running ScanCode.io as a Docker image
+  https://github.com/nexB/scancode.io/issues/9
+
 - Add support for Python 3.7, 3.8, and 3.9
   https://github.com/nexB/scancode.io/issues/54
 

docker-compose.yml

@@ -11,6 +11,8 @@ services:
     build: .
     environment:
       - SCANCODEIO_DB_HOST=db
+      # Required by metaflow to prevent raising MetaflowUnknownUser
+      - USERNAME=scancodeio
     command: sh -c "python manage.py migrate && python manage.py runserver 0.0.0.0:8000"
     volumes:
       - .:/code

docs/docker-image.rst

@@ -0,0 +1,54 @@
+.. _docker_image:
+
+Docker image
+============
+
+Get Docker
+----------
+
+The first step is to download and install Docker on your platform.
+Refer to the following Docker documentation and choose the best installation
+path for you: `Get Docker <https://docs.docker.com/get-docker/>`_
+
+Build the Image
+---------------
+
+ScanCode.io is distributed with ``Dockerfile`` and ``docker-compose.yml`` files
+required for the creation of the Docker image.
+
+Build the image::
+
+    $ docker-compose build
+
+
+.. note::
+    The image will need to be re-build when the ScanCode.io app source code if
+    modified or updated.
+
+Run the Image
+-------------
+
+Run your image as a container::
+
+    $ docker-compose up
+
+
+At this point, the ScanCode.io app should be running at port 8000 on your
+Docker host.
+Go to http://localhost:8000 on a web browser to access the web UI.
+
+You can also run a one-off ``scanpipe`` command through the Docker command line
+interface, for example::
+
+    $ docker-compose run web scanpipe create-project project_name
+
+
+.. note::
+    Refer to :ref:`scanpipe_command_line` for the full list of commands.
+
+Alternatively, you can connect to the Docker container ``bash`` and run commands
+from there::
+
+    $ docker-compose run web bash
+    $ scanpipe create-project project_name
+

docs/index.rst

@@ -11,6 +11,7 @@ First application is for Docker container and VM composition analysis.
 
     introduction
     installation
+    docker-image
 
 .. toctree::
     :maxdepth: 2

docs/installation.rst

@@ -11,6 +11,10 @@ Pre-requisite
  * **PostgreSQL 10** or later: https://www.postgresql.org/ (or https://postgresapp.com/ on macOS)
  * Recent version of **git**: https://git-scm.com/
 
+.. note::
+    ScanCode.io can also be run through a Docker image,
+    refer to the :ref:`docker_image` chapter for details.
+
 Local installation
 ------------------