Skip to content

Commit 72aec03

Browse files
committed
Add tl;dr and warn about serving on network
Explicitly mention that serving VulnerableCode on a network could be security issue and there are several steps that may be needed to secure such a deployment. Further, a quick tl;dr to run with docker in readme is added for convenience. Signed-off-by: Hritik Vijay <hritikxx8@gmail.com>
1 parent 4b1604a commit 72aec03

2 files changed

Lines changed: 19 additions & 1 deletion

File tree

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,18 @@ Using Docker Compose
9595

9696
Please find the docker documentation in `Docker Installation <docs/docker_installation.rst>`__
9797

98+
TL;DR
99+
""""""
100+
101+
.. code-block:: bash
102+
103+
git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode
104+
make envfile
105+
docker-compose up
106+
107+
Go to http://localhost:8000/ on a web browser to access the web UI.
108+
109+
98110
Without Docker Compose
99111
~~~~~~~~~~~~~~~~~~~~~~
100112

docs/docker_installation.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ At this point, the VulnerableCode app should be running at port ``8000`` on your
4545
Go to http://localhost:8000/ on a web browser to access the web UI.
4646
Optionally, you can set ``NGINX_PORT`` environment variable in your shell or in the `.env` file to run on a different port than 8000.
4747

48-
.. warning::
48+
.. note::
4949

5050
To access a dockerized VulnerableCode app from a remote location, the ``ALLOWED_HOSTS``
5151
setting need to be provided in your ``docker.env`` file::
@@ -55,6 +55,12 @@ Optionally, you can set ``NGINX_PORT`` environment variable in your shell or in
5555
Refer to `Django ALLOWED_HOSTS settings <https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts>`_
5656
for documentation.
5757

58+
.. warning::
59+
60+
Serving VulnerableCode on a network could lead to security issues and there
61+
are several steps that may be needed to secure such a deployment.
62+
Currently, this is not recommendend.
63+
5864

5965
Invoke the importers
6066
--------------------

0 commit comments

Comments
 (0)