https://github.com/wireapp/poll-bot
You know... for polls
https://github.com/wireapp/poll-bot
exposed ktor poll-bot roman wire
Last synced: 4 months ago
JSON representation
You know... for polls
- Host: GitHub
- URL: https://github.com/wireapp/poll-bot
- Owner: wireapp
- License: mit
- Created: 2020-02-26T08:27:45.000Z (over 6 years ago)
- Default Branch: staging
- Last Pushed: 2025-02-21T16:04:07.000Z (over 1 year ago)
- Last Synced: 2025-02-21T17:20:27.648Z (over 1 year ago)
- Topics: exposed, ktor, poll-bot, roman, wire
- Language: Kotlin
- Size: 398 KB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wire Poll Bot
[](https://badge.fury.io/gh/wireapp%2Fpoll-bot)
[Wire](https://wire.com/) 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:
```bash
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](https://ktor.io/)
* HTTP Client - [Apache](https://ktor.io/clients/http-client/engines.html) under [Ktor](https://ktor.io/)
* Dependency Injection - [Kodein](https://github.com/Kodein-Framework/Kodein-DI)
* Build system - [Gradle](https://gradle.org/)
* Communication with [Wire](https://wire.com/) - [Roman](https://github.com/dkovacevic/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](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](Makefile).
## Docker Images
Poll bot has public [docker image](https://quay.io/wire/poll-bot).
```bash
quay.io/wire/poll-bot
```
Tag `latest` is the latest release. [Releases](https://github.com/wireapp/poll-bot/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.
```kotlin
/**
* 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](src/main/kotlin/com/wire/bots/polls/setup/EnvConfigVariables.kt).
## 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:
```bash
# 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:
```bash
# 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
```