Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Remove references to old scan queue commands in readme #391
    * Remove manage_purldb_public.py

Signed-off-by: Jono Yang <jyang@nexb.com>
  • Loading branch information
JonoYang committed Apr 18, 2024
commit 983ec4cb7a7fc2973a56e00a24f86e44f6be8b72
24 changes: 3 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Installation
Requirements
############
* Debian-based Linux distribution
* Python 3.8 or later
* Python 3.11 or later
* Postgres 13
* git
* scancode-toolkit runtime dependencies (https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#install-prerequisites)
Expand Down Expand Up @@ -89,23 +89,6 @@ variables will have to be set for the scan queue commands to work:
SCANCODEIO_URL=<ScanCode.io API URL>
SCANCODEIO_API_KEY=<ScanCode.io API Key>

The scan queue is run using two commands:
::

make request_scans

``request_scans`` will send a Package scan request to a configured ScanCode.io
instance. ScanCode.io will download, extract, and scan the files of the
requested Package.
::

make process_scans

``process_scans`` will poll ScanCode.io for the status of the Package scans
requested by ``request_scans``. When a Package scan on ScanCode.io is ready,
``process_scans`` will use that data to create Resources and populate the
MatchCode directory fingerprint indices.

Package Resource data can also be gathered by running ClearCode, where Package
scan data from clearlydefined is collected and its results are used to create
Packages and Resources.
Expand Down Expand Up @@ -206,9 +189,8 @@ All requests to the host go to the PurlDB service, but requests that go to the
To run PurlDB and Matchcode.io with Docker:
::

docker compose -f docker-compose_traefik.yml up -d
docker compose -f docker-compose_purldb.yml up -d
docker compose -f docker-compose_matchcodeio.yml up -d
docker compose -f docker-compose.yml up -d
docker compose -f docker-compose.matchcodeio.yml up -d

Funding
-------
Expand Down
2 changes: 2 additions & 0 deletions docker-compose.common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ services:
clearindex:
build: .
command: wait-for-it web:8000 -- python manage_purldb.py run_clearindex
env_file:
- docker_purldb.env
profiles:
- clearsync
depends_on:
Expand Down
22 changes: 11 additions & 11 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,6 @@ include:
- docker-compose.common.yml

services:
traefik:
image: "traefik:v2.10"
container_name: "traefik"
hostname: "traefik"
ports:
- "80:80"
- "443:443"
volumes:
- "/var/run/docker.sock:/var/run/docker.sock:ro"
- "./traefik.yml:/traefik.yml:ro"

nginx:
image: nginx
labels:
Expand All @@ -29,6 +18,17 @@ services:
depends_on:
- web

traefik:
image: "traefik:v2.10"
container_name: "traefik"
hostname: "traefik"
ports:
- "80:80"
- "443:443"
volumes:
- "/var/run/docker.sock:/var/run/docker.sock:ro"
- "./traefik.yml:/traefik.yml:ro"

networks:
default:
name: purldb
Expand Down
19 changes: 0 additions & 19 deletions manage_purldb_public.py

This file was deleted.