asterisk-config-deploy

An Ansible role that deploys Asterisk config, sounds and moh files from a git repository

The role will checkout configuration files from a git repository into a working directory and then symlink these files into the asterisk config directory.

WARNING: This will delete your original asterisk config files! Do not run on an existing server.

The role will also symlink directories containing custom 'sounds' and 'moh' files.

To use this option you should look into using Git LFS for storing the sound files. The role will install git-lfs on the server for you.

Asterisk Config File Override System

Config files specific to a particular server can be placed into a subfolder in the repository. This can help when you have a generic dialplan but need to configure extensions/trunks etc for multiple regions/offices/customers.

eg. Config files for the US PABX in "asterisk/us/" and the UK PABX in "asterisk/uk/"

The path to the relevant subfolder can be set in a host variable (asterisk_config_deploy_ast_override_dir). The role will deploy any server specific config files that are present instead of the more 'generic' files of the same name in the main folder.

Asterisk Sounds

Custom asterisk sound files can be added to a directory in the repo (default dir: sounds). This directory will be symlinked to the 'custom' asterisk 'sounds' directory.

Asterisk Music On Hold

Custom asterisk 'music on hold' files can be added to a directory in the repo (default dir: moh). This directory will be symlinked to a 'custom' directory under the asterisk 'moh' directory (so we don't lose the original moh files). If you would prefer to overwrite the default moh files instead, set 'asterisk_config_deploy_moh_path' to the actual moh path.

Requirements

Requires a working asterisk installation and a git repository that contains your config files.

If your config repository is private (recommended) then look at setting up ssh-agent forwarding so that the git task can utilise your SSH keys without you having to leave your SSH keys on the asterisk server:

https://developer.github.com/v3/guides/using-ssh-agent-forwarding/

If you have multiple users applying this role then ensure you add them all to a group and pass the group name to the role using the asterisk_config_deploy_group variable.

Role Variables

See defaults/main.yml.

Dependencies

No forced dependencies. Choose your preferred method of installing Asterisk. You may wish to take a look at:

https://galaxy.ansible.com/LukasGibb/asterisk/

Example Playbook

Obviously you will need to pass in your git repository details (not the example/default ones):

- hosts: pabxservers
  vars: 
    asterisk_config_deploy_repo_protocol: "ssh://" 
    asterisk_config_deploy_repo_url: "github.com/myusername/myprivateasteriskconfigrepo"
    asterisk_config_deploy_repo_subfolder: "asterisk-config"
    asterisk_config_deploy_repo_override_subfolder: "asterisk-config/pbx1"
  
  roles:
    - LukasGibb.asterisk
    - LukasGibb.asterisk-config-deploy

License

MIT

Author Information

This role was created in 2018 by: Lukas Gibb CloudJourneyman.com