Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ bin/

# Environments
.env
/vulnerablecode-config/
.venv
env/
venv/
Expand Down
17 changes: 17 additions & 0 deletions docker-compose.windows.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
services:
vulnerablecode:
volumes:
- ./vulnerablecode-config:/etc/vulnerablecode/
- static:/var/vulnerablecode/static/

vulnerablecode_scheduler:
volumes:
- ./vulnerablecode-config:/etc/vulnerablecode/

vulnerablecode_rqworker:
volumes:
- ./vulnerablecode-config:/etc/vulnerablecode/

vulnerablecode_rqworker_high:
volumes:
- ./vulnerablecode-config:/etc/vulnerablecode/
46 changes: 46 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,51 @@ to run on a different port than 8000.

Set ``STAGING=False`` in ``.env`` file to disable the staging environment warning.

.. _run_with_docker_windows:

Windows installation with Docker
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Windows users should run VulnerableCode with Docker Desktop. Native Windows
installation is not supported.

Install and start Docker Desktop, then open PowerShell and clone the repository::

git clone https://github.com/aboutcode-org/vulnerablecode.git
cd vulnerablecode

``make envfile`` is not available on Windows. Instead, create a
``vulnerablecode-config`` directory in the repository root containing a ``.env``
file with the following content::

SECRET_KEY="<your-secret-key>"
ALTCHA_HMAC_KEY="<your-altcha-hmac-key>"

Replace both placeholder values with your own unique secret values.

The repository's existing ``docker.env`` file supplies the database and Redis
container settings; keep it in the repository root. The ``vulnerablecode-config``
directory contains secrets and is ignored by git; do not commit it.

The repository includes ``docker-compose.windows.yml`` to mount this configuration
directory into the application, scheduler, and RQ worker containers. Start and
check the services with::

docker compose -f docker-compose.yml -f docker-compose.windows.yml config --quiet
docker compose -f docker-compose.yml -f docker-compose.windows.yml up -d --build
docker compose -f docker-compose.yml -f docker-compose.windows.yml ps

Check that all services are running and review their logs if startup fails::

docker compose -f docker-compose.yml -f docker-compose.windows.yml logs --tail=100

VulnerableCode should then be available at::

http://localhost

To stop the services::

docker compose -f docker-compose.yml -f docker-compose.windows.yml down

.. _local_development_installation:

Expand All @@ -107,6 +152,7 @@ Supported Platforms

.. warning::
On **Windows** VulnerableCode can **only** :ref:`run_with_docker` and is not supported.
See :ref:`run_with_docker_windows`.

Pre-installation Checklist
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down