ghe-license-mailer

Send a GitHub Enterprise license usage report via email.

Role Variables

• ghe_host

  GitHub Enterprise Hostname :information_source: https://help.github.com/enterprise/admin/guides/installation/configuring-a-hostname/

  ghe_host: github.example.com
  

• ghe_token

  GitHub Enterprise personal access token. :information_source: https://help.github.com/enterprise/user/articles/creating-a-personal-access-token-for-the-command-line/

  ghe_token: 0000a0000a0000a0000a0000a0000a0000a0000a
  

• email_to

  The :email: email-address(es) the license usage report is being sent to. Can be a comma-separated list for multiple recipients.

  email_to: [email protected]
  

• email_from

  The email-address the mail is sent from.

  email_from: [email protected]
  

• email_company

  Your company name.

  email_company: 'ACME, Inc.'
  

• smtp_host

  The mail server.

  smtp_host: smtp.example.com
  

• smtp_port

  The mail server port. This must be a valid integer between 1 and 65534.

  smtp_port: 25
  

• smtp_username

  If SMTP requires username. null if not.

  smtp_username: username
  

• smtp_password

  If SMTP requires password. null if not.

  smtp_password: PassW0rd!
  

Example Playbook

---
- name: GitHub Enterprise license usage mailer
  hosts: localhost
  gather_facts: true	# required for `ansible_date_time` info

  vars:
    ghe_host: github.example.com
    ghe_token: 0000a0000a0000a0000a0000a0000a0000a0000a
    email_to: [email protected]
    email_from: [email protected]
    email_company: 'ACME, Inc.'
    smtp_host: smtp.example.com
    smtp_port: 25
    smtp_username: username
    smtp_password: PassW0rd!

  roles:
    - role: stoe.ghe_license_mailer

License

MIT © Stefan Stölzle