Docker Proffix Middleware Invoice

Inserts OpenTRANS invoice data via proffix api into proffix erp system.

Getting Started with docker

These instructions will cover usage information and for the docker container

Docker Parameters

For LIVE/TEST you need to login to ghcr.io first

Docker

Live

docker run -p 8000:8000 -d ghcr.io/io-market-ag/proffix-middleware-invoice:latest

Test

docker run -p 8000:8000 -d ghcr.io/io-market-ag/proffix-middleware-invoice:test

Docker Composer

Dev

docker-compose -f docker-compose.dev.yml up --build --force-recreate

Useful information about the docker

Environment Variables

• LOG_LEVEL - Logging level, Default: INFO
• API_USER - Proffix API username, Example: 'APIUSR'
• API_PASS - Proffix API password, Example: '142aa6f36755aff833d9bdc9efefd0687eca42a3d06d5217a04bafeb36e8c0ae'
• API_DB - Proffix DB name, Example: 'PX0000312'
• KAFKA_HOST - Kafka hostname:port
• IDENTIFIER - Kafka topic of this microservice, Example: 'Proffix-Middleware-Invoice'
• ERROR_KAFKA_TOPIC - Kafka error topic, Example: 'G2B_error'
• LOG_KAFKA_TOPIC - Kafka group id, Example: 'G2B_log'
• WIREGUARD_ALLOWED_IPS - All the ips in wireguard vpn that can be accessed in the docker container, Example: '10.0.1.0/24'
• WIREGUARD_GATEWAY_IP - The gateway ip of the wireguard vpn., Example: '10.0.1.1'
• WIREGUARD_ENDPOINT - the public key of the wireguard serve, Example: '76.176.12.19:51821'
• WIREGUARD_SERVER_PUBLIC_KEY - The public key of the wireguard server, Example: '6HTqHaKY6rl5LVSFy61qx319/+CK2b48kTyfYb7Ty3s='
• WIREGUARD_CLIENT_IP - The client ip of the wireguard client, Example: '10.0.1.57'
• WIREGUARD_CLIENT_PRIVATE_KEY - The private key of the wireguard client, Example: 'IHCoW0nBJ6DLw92nAMIuuXorHZkOLdQP+OTveVU/1EQ='

.env File

All enviornment variables should be saved in the .env file and refrenced in the docker-compose file. The variables required by the docker container are to be saved into the .env.example file for upload in repo.

You will find more information in the documentation.

Volumes

• /FOLDER_WITH_OPENTRANS_INVOICES - Mount folder that will contain the invoice OpenTRANS files.

Kafka Message

The Kafka Message needs to be a dictionary with the following variables:

{
   "opentrans_path": "PUT_THE_PATH_TO_THE_OPENTRANS_FILE_HERE"
}