Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration

All ShopiTerm services can be configured through environment variables. This page lists all available configuration options per service.

Catalogue

VariableDescriptionDefault
LISTENAddress on which to listen onlocalhost:3000
DBAddress of PostgreSQL instancepostgres:///shopiterm_catalogue?host=/var/run/postgresql
WAREHOUSEAddress of the warehouse servicehttp://localhost:3002
NATSAddress of the NATS serverlocalhost:4222

Warehouse

VariableDescriptionDefault
LISTENAddress on which to listen onlocalhost:3000
DBAddress of PostgreSQL instancepostgres:///shopiterm_warehouse?host=/var/run/postgresql
CATALOGUEAddress of the catalogue servicehttp://localhost:3001

Orders

VariableDescriptionDefault
LISTENAddress on which to listen onlocalhost:3000
DBAddress of PostgreSQL instancepostgres:///shopiterm_orders?host=/var/run/postgresql
NATSAddress of NATS instancelocalhost:4222
WAREHOUSEAddress of warehouse servicehttp://localhost:3002
CATALOGUEAddress of catalogue servicehttp://localhost:3001

Notificator

VariableDescriptionDefault
NATSAddress of the NATS serverlocalhost:4222
MAILER_HOSTAddress of the mailerlocalhost
MAILER_PORTPort of the mailer1025
ORDERAddress of order servicehttp://localhost:3003

Payment

VariableDescriptionDefault
TALER_BACKENDAddress of the Taler merchant backendhttps://backend.demo.taler.net
TALER_INSTANCEInstance on the Taler merchant backend to usesandbox
TALER_TOKENBearer token to use for Taler authorizationsecret-token:sandbox
NATSAddress of the NATS servernats://localhost:4222

Recommendations

VariableDescriptionDefault
LISTENAddress to bind the HTTP listener onlocalhost:3003
DATABASE_URLPostgreSQL connection URLrequired
CATALOGUE_URLBase URL of the catalogue servicehttp://localhost:3001
NATS_URLNATS server URL for the JetStream product-events streamnats://localhost:4222
RECOMPUTE_INTERVAL_SECSInterval in seconds between background recomputation passes (0 disables)300
WEIGHT_VIEWScore weight for a "view" interaction1.0
WEIGHT_ADD_TO_CARTScore weight for an "add_to_cart" interaction4.0
WEIGHT_PURCHASEScore weight for a "purchase" interaction10.0
PERSONALIZED_WINDOW_DAYSWindow in days of recent interactions used as seed signal for personalized recommendations30

SSH Server

VariableDescriptionDefault
LISTENAddress on which to listen for SSH connections0.0.0.0:2222
GATEWAY_URLBase URL of the gateway APIhttp://localhost:8080
HOST_KEY_FILEPath to an OpenSSH private key file for the host keyoptional
HOST_KEYPEM string for the host key (alternative to HOST_KEY_FILE)optional
DBPostgreSQL connection URLpostgres:///shopiterm_ssh?host=/var/run/postgresql
JWT_SECRETJWT secret for authenticationYS1zdHJpbmctc2VjcmV0LWF0LWxlYXN0LTI1Ni1iaXRzLWxvbmc