Skip to content

Commit

Permalink
Feature: API keys configuration
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
theLogicJB committed Oct 13, 2024
1 parent 5f9f65e commit 66569c9
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,28 @@ You can check the performance of the container with the command

docker exec -it jobe /var/www/html/jobe/testsubmit.py --perf

## Using API Keys

You can provid API keys during the image build via the `--secret` option.

The keys can be stored in a separate file, following the format:

```
'c1425880-2289-4b76-ae29-bcea34997256' => 0,
'de7970e6-0466-4ce2-a6a4-c1a51363bd03' => 90
```

You can find more information on API keys in the Jobe documentation.

With the following command the keys stored in a file called `api_keys` in the
jobeinabox directory are automatically added to `/var/www/html/jobe/app/Config/Jobe.php`
and the option `$require_api_keys` is set to true.

```
podman build . -t my/jobeinabox --secret id=api_keys,src=api_keys
```

If no API keys are provided the configuration remains untouched.

### Warnings:

Expand Down

0 comments on commit 66569c9

Please sign in to comment.