BPQ API Extensions

This repository is a docker-compose file that will bring up the API extension wrappers around BPQ.

These include:

• HTTP API - Provide a Swagger compatible HTTP API
• IMAP - Export Personal and Bulletin mail via IMAP
• RoundCube - Mail interface
• Mosquitto - MQTT server for event output
• BPQMON - View BPQ activity in the terminal via docker logs

Starting the services.

docker compose up -d

This will bring up all the services, hopefully in a sensible state.

Configuring BPQ

The amount of configuration required in BPQ is minimal, however to take advantage of the MQTT events, some configuration must be added.

# Edit /etc/bpq32.cfg
MQTT=1
MQTT_HOST=localhost
MQTT_PORT=1883
MQTT_USER=bpqmon
MQTT_PASS=bpqmon

The IMAPAPI service also includes an SMTP server. In order to use this, the native BPQ SMTP port must be disabled.

Ensure that 'SMTP Port' is 0 in Configuration.

Security Note

None of these API extensions are encrypted. They also ship with default passwords. DO NOT expose these to the public internet.

Relevant Ports

• IMAP - 143
• HTTP API - 8080
• RoundCube - 8000
• MQTT - 1883