Forge Home

openfire

Openfire puppet module

10,353 downloads

9,788 latest version

4.5 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.2
  • 0.0.1
released Jan 21st 2015
This version is compatible with:

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'forj-openfire', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add forj-openfire
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install forj-openfire --version 0.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: xmpp, openfire, chat

Documentation

forj/openfire — version 0.0.3 Jan 21st 2015

OpenFire

Puppet Forge License

This module installs Openfire chat server.

How to use

##Simple config:

include openfire

In this way it will install using all the default values, you can access your new server this way:

  1. In your browser go to http://server_address:9090
  2. Login using: admin/changeme

##To create a new chat group:

openfire::room { 'group_id':
  room_name   => 'group_friendly_name',
  description => 'group description',
}

##To create a new user of modify it:

openfire::user { 'user_name':
  password => 'user_password',
}

##To create a Group:

openfire::group { 'group_name': }

##To Add a User to an existing group:

openfire::usergroup { 'Openfire:user_name>group_name' :
  user    => 'user_name',
  group   => 'group_name',
  require => [ Openfire::User['user_name'], Openfire::Group['group_name'] ],
}

##To add a plug-in:

just add it in the main class declaration, the name is the jar file name that is listed in openfire plugin page:

class { '::openfire':
  plugins   => ['monitoring.jar'],
}

##Prepare your server to use it with hubot:

You can use this example to configure openfire to accept hubot connections.

class { '::openfire':
  of_admin_pass => 'secret',
  of_config     => {
    'xmpp.domain'                               => { value => $::fqdn },
    #Disable TLS
    'xmpp.client.tls.policy'                    => { value => 'disabled' },
    'xmpp.server.tls.enabled'                   => { value => 'true' },
    'xmpp.server.dialback.enabled'              => { value => 'true' },
    'xmpp.server.certificate.accept-selfsigned' => { value => 'false' },
    #Disable SSL
    'xmpp.socket.ssl.active'                    => { value => 'false' },
  },
  plugins       => ['monitoring.jar'],
}

Parameters

  • install_java : installs java jre (default: true)
  • tar_url : Openfire tar url (default: 'http://www.igniterealtime.org/downloadServlet?filename=openfire/openfire_3_9_3.tar.gz')
  • plugins_base_url : Openfire's plugins url (default: 'http://www.igniterealtime.org/projects/openfire/plugins')
  • user_home : Openfire installation path (default: '/opt/openfire')
  • dbhost : MySQL server (default: 'localhost')
  • dbport : MySQL server port (default: '3306')
  • dbname : MySQL Database name to create (default: 'openfiredb')
  • dbuser_name : MySQL user for the database (default: 'openfire')
  • dbuser_pass : MySQL user's password (default: 'changeme')
  • of_port : Openfire port (default: '9090')
  • of_secure_port : Openfire secure port (default: '9091')
  • of_admin_pass : Openfire admin password (default: 'changeme')
  • of_config : Openfire configuration values (Hash) (default: { 'xmpp.domain' => { value => $::fqdn }})
  • plugins : Openfire plgins to install (default: [])

License

Released under the Apache 2.0 licence

Contact

Known Issues:

  • Only tested on Ubuntu
  • Only works with mysql
  • Specs missing
  • Port changing only works in the first run, this is due Openfire changes config files checksum whenever it runs.

Support

Please log tickets and issues at our GitHub repository

Contribute:

Contribute to this project here