Run with local message bus#

Blueapi can publish updates to a message bus asynchronously, the CLI can then view these updates display them to the user.

Start RabbitMQ#

The worker requires a running instance of RabbitMQ. The easiest way to start it is to compose the services in tests/system_tests/compose.yaml

docker compose -f tests/system_tests/compose.yaml run rabbitmq --detach

Config File#

Create a YAML file for configuring blueapi:

# stomp.yaml

# Edit this if your message bus of choice is running on a different host,
# if it has different credentials,
# or if its STOMP plugin is running on a different port
stomp:
  enabled: true # All other stomp settings will be ignored if this is false
  url: tcp://localhost:61613
  auth:
    username: guest
    password: guest

Run the Server#

blueapi --config /path/to/stomp.yaml serve

The server should print a connection message to the console. If there is an error, it will print an error message instead.