Skip to content

docs: add details on how to enable PurlDB authentication #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keshav-space merged 1 commit into from
Nov 12, 2026
+40 −1
Merged

docs: add details on how to enable PurlDB authentication #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 40 additions & 1 deletion deploy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ make envfile
Open `/opt/purldb/.env` in a text editor and populate with this config:

```
PURLDB_REQUIRE_AUTHENTICATION=False
ALLOWED_HOSTS=<your host>
SITE_URL=https://<your host>/
PURLDB_PUBLIC_SETUP=True
Expand All @@ -164,6 +165,14 @@ sudo docker compose -f /opt/purldb/docker-compose.yml build
sudo docker compose -f /opt/purldb/docker-compose.yml up -d
```

> [!NOTE]
> By default `PURLDB_REQUIRE_AUTHENTICATION` is set to `True`, an authentication token is required to access the PurlDB API.
>
> Once PurlDB is up and running, generate an authentication token by running:
> ```bash
> sudo docker compose -f /opt/purldb/docker-compose.yml exec web ./manage.py create-user --generate-api-key <username>
> ```

Once completed, make sure that PurlDB is up and running.


Expand Down Expand Up @@ -205,6 +214,8 @@ sudo vi /opt/scancodeio/.env

Populate with this config:
```
SCANCODEIO_REQUIRE_AUTHENTICATION=False

GRIMOIRELAB_URL="http://grimoirelab-nginx:8000/"
GRIMOIRELAB_OPENSEARCH_URL="https://grimoirelab-opensearch:9200/"
GRIMOIRELAB_ECOSYSTEM="npmlargerecosystem"
Expand All @@ -229,6 +240,16 @@ GRIMOIRELAB_OPENSEARCH_USERNAME=""
GRIMOIRELAB_OPENSEARCH_PASSWORD=""
```


> [!NOTE]
> By default, `SCANCODEIO_REQUIRE_AUTHENTICATION` is set to `True`, which means a username and password are required to log in to ScanCode.io.
>
> Once ScanCode.io is up and running, create a user using the following command:
> ```bash
> docker compose -f /opt/scancodeio/docker-compose.yml exec web ./manage.py scanpipe create-user <username>
> ```


#### Expose ScanCode.io on port 8443

This is optional, and enables access to the ScanCode.io scan worker.
Expand Down Expand Up @@ -335,7 +356,7 @@ docker compose -f /opt/healthycode/deploy/docker-compose/docker-compose-grimoire

## Enable authentication for ScanCode.io (Optional):

Add this to `/opt/scancodeio/.env`
Add/edit this to `/opt/scancodeio/.env`

```
SCANCODEIO_REQUIRE_AUTHENTICATION=True
Expand All @@ -349,6 +370,24 @@ docker compose -f /opt/scancodeio/docker-compose.yml exec web ./manage.py scanpi

Restart ScanCode.io service.


## Enable authentication for PurlDB (Optional):

Add/edit this to `/opt/purldb/.env`

```
PURLDB_REQUIRE_AUTHENTICATION=True
```

Run this command to generate auth token required to access PurlDB API:

```
sudo docker compose -f /opt/purldb/docker-compose.yml exec web ./manage.py create-user --generate-api-key <username>
```

Restart PurlDB service.


## SSL/TLS Configuration

Add `fullchain.pem` and `privkey.pem` for your host inside:
Expand Down
Loading