voicemail-ticketizer/README.md

# voicemail-ticketizer

`voicemail-ticketizer` creates Sonar tickets of RingCentral voicemails.

## Configuration

```shell
# Required API endpoint/authentication variables
SONAR_URL=https://instance.sonar.software/api/graphql
SONAR_TOKEN=
RINGCENTRAL_CLIENT_ID=
RINGCENTRAL_CLIENT_SECRET=
RINGCENTRAL_USERNAME=
RINGCENTRAL_EXTENSION=
RINGCENTRAL_PASSWORD=

# Set to 'sandbox' to use RingCentral's sandbox API
# Any other value will result in using RingCentral's production API
RINGCENTRAL_SERVER=production

# The database to use
# valid options: pg, sqlite
# default: sqlite
DB_ENGINE=sqlite # can be pg

# Only used when DB_ENGINE=pg
DB_URL=
# Only used when DB_ENGINE=sqlite
# default: voicemails.db
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
```

## 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
    volumes:
      - data:/data
```