Skip to content

Commit ac5a156

Browse files
committed
docs: update installation guide
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
1 parent 50be4b7 commit ac5a156

1 file changed

Lines changed: 42 additions & 25 deletions

File tree

docs/source/installation.rst

Lines changed: 42 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
Installation
44
============
55

6-
.. warning::
7-
VulnerableCode is going through a major structural change and the
8-
installations are likely to not produce enough results.
9-
This is tracked in https://github.com/aboutcode-org/vulnerablecode/issues/597
10-
116
Welcome to **VulnerableCode** installation guide! This guide describes how to install
127
VulnerableCode on various platforms.
138
Please read and follow the instructions carefully to ensure your installation is
@@ -58,11 +53,19 @@ Run the App
5853

5954
**Run your image** as a container::
6055

61-
docker compose up
56+
docker compose up -d \
57+
--scale vulnerablecode_rqworker=4 \
58+
--scale vulnerablecode_rqworker_high=2
59+
60+
.. tip::
61+
62+
Adjust the scaling factor as needed, or based on the recommendation shown in ``Load Factor`` at http://localhost:8000/pipelines/dashboard/.
63+
6264

6365

6466
At this point, the VulnerableCode app should be running at port ``8000`` on your Docker host.
6567
Go to http://localhost:8000/ on a web browser to access the web UI.
68+
Go to http://localhost:8000/pipelines/dashboard/ to view the run status of the importer and improver pipelines.
6669
Optionally, you can set ``NGINX_PORT`` environment variable in your shell or in the `.env` file
6770
to run on a different port than 8000.
6871

@@ -86,29 +89,11 @@ to run on a different port than 8000.
8689

8790
.. tip::
8891

89-
Set ``STAGING`` to ``False`` in production to disable the staging environment warning.
90-
91-
Execute a Command
92-
^^^^^^^^^^^^^^^^^
93-
94-
You can execute a one of ``manage.py`` commands through the Docker command line
95-
interface, for example::
96-
97-
docker compose run vulnerablecode ./manage.py import --list
98-
99-
.. note::
100-
Refer to the :ref:`command_line_interface` section for the full list of commands.
101-
102-
Alternatively, you can connect to the Docker container ``bash`` and run commands
103-
from there::
104-
105-
docker compose run vulnerablecode bash
106-
./manage.py import --list
92+
Set ``STAGING=False`` in ``.env`` file to disable the staging environment warning.
10793

10894

10995
.. _local_development_installation:
11096

111-
11297
Local development installation
11398
------------------------------
11499

@@ -219,6 +204,38 @@ application.
219204
development**.
220205

221206

207+
Run Pipelines
208+
^^^^^^^^^^^^^
209+
210+
For local testing, you can use the ``manage.py`` commands to run importer and improver pipelines.
211+
212+
To list the available importer pipelines::
213+
214+
./manage.py import --list
215+
216+
217+
To run an importer pipeline::
218+
219+
./manage.py import curl_importer_v2
220+
221+
222+
To list the available improver pipelines::
223+
224+
./manage.py improve --list
225+
226+
To run an improver pipeline::
227+
228+
./manage.py improve compute_package_risk_v2
229+
230+
231+
.. note::
232+
Running a pipeline using a `manage.py` command will not display it on the ``Pipeline Dashboard``. Instead, all logs will be printed directly to the CLI.
233+
234+
235+
.. tip::
236+
Refer to the :ref:`command_line_interface` section for the complete list of commands.
237+
238+
222239
Upgrading
223240
^^^^^^^^^
224241

0 commit comments

Comments
 (0)