voicemail-ticketizer/README.md

63 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2021-03-10 22:23:41 -07:00
# voicemail-ticketizer
`voicemail-ticketizer` creates Sonar tickets of RingCentral voicemails.
## Configuration
```shell
# Required API endpoint/authentication variables
2021-03-10 22:23:41 -07:00
SONAR_URL=https://instance.sonar.software/api/graphql
SONAR_TOKEN=
RC_APP_KEY=
RC_APP_SECRET=
RC_LOGIN_USERNAME=
RC_LOGIN_EXT=
RC_LOGIN_PASSWORD=
# Set to any value to enable use of RingCentral's sandbox API
RC_SANDBOX=
# The database to use
# valid options: pg, sqlite
# default: sqlite
2021-03-10 22:23:41 -07:00
DB_ENGINE=sqlite # can be pg
# Only used when DB_ENGINE=pg
2021-03-10 22:23:41 -07:00
DB_URL=
# Only used when DB_ENGINE=sqlite
# default: voicemails.db
2021-03-10 22:23:41 -07:00
DB_FILE=voicemails.db
# A mapping of extension number to Sonar Ticket Group
# Only the voicemail boxes of these extensions will be checked
EXTENSION_TICKET_GROUPS=1:1,2:2,2:3
# Upon first run, query RingCentral voicemails up to FIRST_RUN_AGE seconds old.
# Useful when the application is restarted after not running for some time.
# default: 86400 (1 day)
FIRST_RUN_AGE=86400
2021-03-10 22:23:41 -07:00
```
## Deployment
Via `docker-compose`:
```yaml
version: "3.8"
volumes:
data:
services:
voicemail-ticketizer:
build: https://git.esis.network/esis/voicemail-ticketizer.git#master
restart: always
environment:
# ... see Configuration above
DB_FILE: /data/voicemails.db
# so the created tickets show the correct 'Received' date & time
TZ: America/Creston
2021-03-10 22:23:41 -07:00
volumes:
- data:/data
```