Wire Poll Bot

Wire bot for the polls. This version is based on Roman therefore does not employ E2EE directly

Service code to enable Poll bot in your team:

3131a0af-89d4-4569-b36d-50bcced4b1fb:163a422b-c314-4e34-95af-10b6b36cde18

Commands

Basic usage

/poll "Question" "Option 1" "Option 2" will create poll
/stats will send result of the latest poll in the conversation
/help to show help
/version prints the current version of the poll bot

Technologies used

HTTP Server - Ktor
HTTP Client - Apache under Ktor
Dependency Injection - Kodein
Build system - Gradle
Communication with Wire - Roman

Bot is using webhooks coming from Roman, for that, the bot needs to have public URL or IP address.

Usage

The bot needs Postgres database up & running - we use one in docker-compose.yml, to start it up, you can use
command make db.
To run the application execute make run or ./gradlew run.
To run the application inside the docker compose environment run make up.

For more details see Makefile.

Docker Images

Poll bot has public docker image.

quay.io/wire/poll-bot

Tag latest is the latest release. Releases have then images with corresponding tag, so you
can always roll back. Tag staging is build from the latest commit in staging branch.

Bot configuration

Configuration is currently being loaded from the environment variables.

    /**
     * Username for the database.
     */
    const val DB_USER = "DB_USER"
    /**
     * Password for the database.
     */
    const val DB_PASSWORD = "DB_PASSWORD"
    /**
     * URL for the database.
     *
     * Example:
     * `jdbc:postgresql://localhost:5432/bot-database`
     */
    const val DB_URL = "DB_URL"
    /**
     * Token which is used for the auth of proxy.
     */
    const val SERVICE_TOKEN = "SERVICE_TOKEN"
    /**
     * Domain used for sending the messages from the bot to proxy eg. "https://proxy.services.zinfra.io/api"
     */
    const val PROXY_DOMAIN = "PROXY_DOMAIN"

Via the system variables - see complete list.

Docker Compose

To run bot inside docker compose environment with default PostgreSQL database,
please create .env file in the root directory with the following variables:

# database
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_DB=
# application
DB_USER=
DB_PASSWORD=
DB_URL=
SERVICE_TOKEN=
PROXY_DOMAIN=

Such configuration can look for example like that:

# database
POSTGRES_USER=wire-poll-bot
POSTGRES_PASSWORD=super-secret-wire-pwd
POSTGRES_DB=poll-bot
# application
DB_USER=wire-poll-bot
DB_PASSWORD=super-secret-wire-pwd
DB_URL=jdbc:postgresql://db:5432/poll-bot
SERVICE_TOKEN=x6jsd5vets967dsA01dz1cOl
APP_KEY=eyJhbGciOiJIUzM4NCJ9.......
PROXY_DOMAIN=https://proxy.services.zinfra.io/api