-
Notifications
You must be signed in to change notification settings - Fork 4
Table of configuration options
Frank Woeckener edited this page Nov 19, 2014
·
5 revisions
These are the configurable parameters to control the Voice stack behavior. Some of them are mandatory, some are optional. Some can be updated after the initial provisioning, some require manual interaction to be changed.
If you're using the Vagrant VM setup you'll copy the Vagrantfile.example to customize the installation. For the production host setup you need to adapt the seeds/node.json accordingly.
Rows marked as M contain mandatory parameters, C marks values that require manual tweaks to be changed
after the first setup. Blocks that can be toggled with a boolean flag (e.g. aws/s3_backup, smtp/activate) need
to be filled in only, if they are turned on.
| M | C | Section/Key | Meaning |
| --- | --- | ------------------- | ----------------------------------------------------------------- |
| | | | |
| | | => ahn | |
| M | | ami_pass | used by Voice-Ahn to access the asterisk AMI |
| | | call_timeout | time in seconds, when a queued call will be directed to voicemail |
| | | dispatch_attempts | how often a call will be dispatched to agents before it fails |
| | | voicemail_available | if customers can leave a message after failed connections |
| | | voicemail_timeout | the max. duration of a voicemail recording, in seconds |
| | | ring_timeout | time in seconds, that phones will ring for incoming calls |
| | | | |
| | | => aws | |
| M | | s3_backup | turns the scheduled AWS/S3 backup on/off |
| | C | gpg_pass | used for symmetric encryption of the backup files (01) |
| | | key_id | your AWS user key-id to access S3 |
| | | secret | your AWS user secret |
| | | s3_bucket | S3 bucket for backups, e.g. s3-eu-west-1.amazonaws.com/my-bucket |
| | | | |
| | | => crm_provider | |
| M | | activate | turns the Zendesk support on/off |
| | | name | the CRM name used for the rails front-end, should be "Zendesk" |
| | | user | your Zendesk API user (is an email address) |
| | | pass | your API password |
| | | domain | the Zendesk domain to be used |
| | | api_url | insert your Zendesk domain into the following URL templates |
| | | user_url | — e.g. https://my-domain.zendesk.com/api/v2 |
| | | ticket_url | these are used for linking and API access |
| | | | |
| | | => etc | |
| M | | domain | the domain name for https-/SIP-access, e.g. my-domain.com (02) |
| M | | external_ip | the external IPv4 address of this VM/host |
| M | | ext_interface | the device that is bound to the external address, e.g. eth0 (03) |
| | | deployment_host | the full hostname of your production host, used for deployments |
| | | ip_blacklist | a list of IPv4 addresses that should be blocked completely |
| | | ip_whitelist | list of addresses that should never be blocked (04) |
| M | | gateway | host-IP, only used for Vagrant VMs — is typically 33.33.33.1 |
| M | | local_net | only for Vagrant VMs, your local network, e.g. 192.168.0.0 |
| M | | local_mask | only Vagrant VMs, the mask of your local net, e.g. 255.255.255.0 |
| | | | |
| | | => git | |
| M | C | gitbase | the Github account for provisioning: git://github.com/fwoeck (05) |
| | | user | used in .gitconfig, if you want to push commits: |
| | | — name | — your committer name |
| | | — email | — your committer email |
| | | github | used for Github API access, e.g. to push gists: |
| | | — user | — your API user name |
| | | — token | — your API token |
| | | | |
| | | => mysql | |
| M | C | wim_pass | the password of the wim sql-user account, used by Ahn and Rails |
| M | C | root_pass | the sql root password |
| | | | |
| | | => rabbitmq | |
| M | C | pass | the password for the wim user's queue- and admin-front end access |
| | | | |
| | | => sip_provider | |
| M | | activate | turns the external SIP trunk support on/off (06) |
| | | pass | the password for the external SIP account |
| | | trunk | the SIP user name, e.g. 1234567t0 for a Sipgate account |
| | | number | the number bound to that SIP trunk, e.g. 3012345678 |
| | | proxy | the external SIP proxy, e.g. sipconnect.sipgate.de |
| | | sms | the SMS feature is currently unused |
| | | — apihost | — unused |
| | | — password | — unused |
| | | — user | — unused |
| | | | |
| | | => skype | |
| M | | activate | controls, whether inbound Skype calls can be made (07) |
| | | pass | the SIP password for Skype |
| | | trunk | the number associated with the Skype account |
| | | proxy | the SIP proxy, typically sip.skype.com |
| | | | |
| | | => smtp | |
| M | | activate | toggles the smtp relaying on/off (08) |
| | | mail_domain | the mail domain of the local MX, typically same as the etc/domain |
| | | mail_from | the local sender of mails, e.g. for daily log reports |
| | | mail_to | the default receiver of systematic emails |
| | | address | name of the relay host, e.g. email-smtp.eu-west-1.amazonaws.com |
| | | port | the submission port, e.g. 587 or 25 |
| | | username | the mail user name for the relay |
| | | password | the password of the relay user |
| | | | |
| | | => vnc | |
| M | C | password | the password used for VNC access to the platform (09) |
| | | | |
| | | => voice_rails | |
| M | | keybase | used by Voice-Rails for session-encryption and form protection |
| | | admin | used to create agents and make test calls |
| M | C | — email | — the admin's email address for https logins (10) |
| M | C | — fullname | — the admin's full name |
| M | C | — password | — the admin's front-end password used for https |
| M | C | — secret | — the admin's SIP secret |
| M | C | — name | — the admin's SIP extension, typically 999 (11) |
| | | | |
| | | => wim | |
| M | | sudoer | should be true for the "desktop" role (default for VMs) (12) |
- If you change this, you won't be able to decrypt your old S3-backups any more.
- The hostname for that comes from your Ubuntu setup or from the Vagrantfile.
- Has to match you network configuration — this is eth0 for the Vagrant VM.
- Exclude your public IP from being blocked due to failed ssh- or SIP-logins.
- Change this to your account for collaboration, e.g. [email protected]:myuser.
- Getting this to work in the Vagrant VM will need extra firewall rules and routing.
- Same as for 06), so this is intended for production hosts without NAT.
- If this is deactivated, all email will end up in the local user's (vagrant/wim) mailbox.
- See Testing and call simulation for details on how to use the VNC screen.
- After provisioning, you log in at the https front-end and create the first agents.
- The 999 is treated as if it were a customer in test calls to the internal number 00.
- It's recommended not to make the wim user a sudoer on production hosts.