Running / Config Guide¶
This section goes over how to run and configure the External Item Search service.
Running¶
This service is distributed as a docker container, hosted on docker hub: https://hub.docker.com/r/ebprod/oqm-plugin-ext_item_search/tags
It has no runtime dependencies, and runs on its own.
Single Host Install¶
To install on the standard single host deployment route, simply install the oqm-plugin-ext+item+search package.
Configuration¶
In General¶
Given this is a Quarkus based application, there is a fair bit of configuration that is a carry-over from the framework. Notable and relevant examples:
Config Key |
Description |
Values (Examples) |
Default |
|---|---|---|---|
quarkus.http.port
|
Sets the port that this service listens to. |
8008
|
8008
|
Service / Provider¶
Note:: URL configuration is noted here for completeness, but you should never need to touch this.
Barcode Lookup
Config Key |
Description |
Values (Examples) |
Default |
|---|---|---|---|
productLookup.providers.barcodelookup-com.enabled
|
If this provider is enabled or not. If api key is blank, overrides this to |
true
|
true
|
productLookup.providers.barcodelookup-com.apiKey
|
The API key to use to authenticate with the service. If not specified, this service is disabled. |
|
|
productLookup.providers.barcodelookup-com.url
|
The base URL of the website for API calls |
https://api.barcodelookup.com/
|
DataKick
Config Key |
Description |
Values (Examples) |
Default |
|---|---|---|---|
productLookup.providers.datakick.enabled
|
If this provider is enabled or not. |
true
|
true
|
productLookup.providers.datakick.url
|
The base URL of the website for API calls |
https://www.gtinsearch.org
|
Rebrickable
Config Key |
Description |
Values (Examples) |
Default |
|---|---|---|---|
productLookup.providers.rebrickable.enabled
|
If this provider is enabled or not. If api key is blank, overrides this to |
true
|
true
|
productLookup.providers.rebrickable.apiKey
|
The API key to use to authenticate with the service. If not specified, this service is disabled. |
|
|
productLookup.providers.rebrickable.url
|
The base URL of the website for API calls |
https://rebrickable.com
|
UPC Item DB
Config Key |
Description |
Values (Examples) |
Default |
|---|---|---|---|
productLookup.providers.upcitemdb.enabled
|
If this provider is enabled or not. |
true
|
true
|
productLookup.providers.upcitemdb.apiKey
|
The API key to use to authenticate with the service. If api key is blank or unspecified, the trial endpoint is used. |
|
|
productLookup.providers.upcitemdb.url
|
The base URL of the website for API calls |
https://api.upcitemdb.com
|
Open Food Facts
https://world.openfoodfacts.org/
Config Key |
Description |
Values (Examples) |
Default |
|---|---|---|---|
productLookup.providers.openfoodfacts.enabled
|
If this provider is enabled or not. |
true
|
true
|
productLookup.providers.openfoodfacts.url-barcode
|
The base URL of the website for API calls for barcodes |
https://world.openfoodfacts.net
|
|
productLookup.providers.openfoodfacts.url-search
|
The base URL of the website for API calls for text searches |
https://search.openfoodfacts.net
|
