Configuration

Main important config keys which can be set via ENV Variables:

CitrineOS MESSAGE API URL - NO Trailing Slash

CITRINEOS_MESSAGE_API_URL="http://localhost:8080/ocpp"

CitrineOS DATA API URL - NO Trailing Slash

CITRINEOS_DATA_API_URL="http://localhost:8080/data"

CitrineOS SCAN AND CHARGE - enable/disable feature

CITRINEOS_SCAN_AND_CHARGE="true"

Url for CitrineOS Directus instance - (required for Scan and Charge)

CITRINEOS_DIRECTUS_URL="http://localhost:8055"

Login Email for CitrineOS Directus instance - (required for Scan and Charge)

CITRINEOS_DIRECTUS_LOGIN_EMAIL="admin@CitrineOS.com"

Login Password for CitrineOS Directus instance - (required for Scan and Charge)

CITRINEOS_DIRECTUS_LOGIN_PASSWORD="CitrineOS!"

CitrineOS Directus QR Code folder - (required for Scan and Charge)

CITRINEOS_DIRECTUS_QR_CODE_FOLDER="put folder id here"

URL which will be used by the frontend application

CLIENT_URL="http://localhost:9010"

Message Broker (RabbitMQ)

Protocol of the Message Broker [amqp / amqps] (required)

MESSAGE_BROKER_SSL_ACTIVE=False

Host of the Message Broker (required)

MESSAGE_BROKER_HOST="127.0.0.1"

Port of the Message Broker (required)

MESSAGE_BROKER_PORT=5672

User of the Message Broker (required)

MESSAGE_BROKER_USER="guest"

Password of the Message Broker (required)

MESSAGE_BROKER_PASSWORD="guest"

Vhost of the Message Broker (required)

MESSAGE_BROKER_VHOST="/"

Exchange type to be used for the Message Broker (deafult: topic)

MESSAGE_BROKER_EXCHANGE_TYPE="headers"

Exchange name to be used for the Message Broker (required)

MESSAGE_BROKER_EXCHANGE_NAME="citrineos"

The name of the queue where this service will listen for events to be processed, e.g. when a TransactionEvent was received. (required)

MESSAGE_BROKER_EVENT_CONSUMER_QUEUE_NAME="paymentService"

Webserver Settings (api used by the frontend)

Host of the web server (required)

WEBSERVER_HOST="0.0.0.0"

Port of the web server (required)

WEBSERVER_PORT=9010

Path which will be used as web routes prefix (e.g. "/path") [""]

WEBSERVER_PATH="/api"

Database settings (required)

DB_HOST="127.0.0.1" DB_PORT=5432 DB_DATABASE="citrine" DB_USER="citrine" DB_PASSWORD="citrine" DB_TABLE_PREFIX="payment_"

Stripe settings

Stripe API Key (required)

(container contains Stackbox' test api key) STRIPE_API_KEY="sk_test_some-stripe-api-key"

Stripe endpoint secret for receiving webhooks from Stripe for endpoint-type "Account" (required)

(Webhook needs to be configured with stripe and given secret needs to be used) STRIPE_ENDPOINT_SECRET_ACCOUNT="whsec_some-stripe-signing-secret"

Stripe endpoint secret for receiving webhooks from Stripe for endpoint-type "Connect" (required)

(Webhook needs to be configured with stripe and given secret needs to be used) STRIPE_ENDPOINT_SECRET_CONNECT="whsec_some-stripe-signing-secret"

Development Setup

To set up your development environment, run the following commands:

./deploy_local.sh

Tests

To execute the tests, run the following command from the root directory:

python -m unittest

Code Style

We use Ruff to lint and format our code.

To run the formatter, run the following command:

ruff format

To run the linter, run the following command:

ruff check