cookbook 'postfixadmin', '= 2.0.0'
postfixadmin (16) Versions 2.0.0 Follow2
Installs and configures PostfixAdmin, a web based interface used to manage mailboxes, virtual domains and aliases.
cookbook 'postfixadmin', '= 2.0.0', :supermarket
knife supermarket install postfixadmin
knife supermarket download postfixadmin
Description
Installs and configures PostfixAdmin, a web based interface used to manage mailboxes, virtual domains and aliases.
Also creates the required MySQL or PostgreSQL database and tables.
Table of Contents
- Requirements
- Generated Passwords
- Attributes
- Recipes
- Resources
- Usage Example
- PostgreSQL Support
- Testing
- Contributing
- TODO
- License and Author
Requirements
Please, if you want to upgrade the postfixadmin
cookbook version from the 1.x
branch, see the CHANGELOG.
Supported Platforms
This cookbook has been tested on the following platforms:
- Amazon Linux
- CentOS
- Debian
- Fedora
- Ubuntu
Please, let us know if you use it successfully on any other platform.
Required Cookbooks
- apache2
- ark
- database
- encrypted_attributes (~> 0.2)
- mysql
- nginx
- php
- php-fpm
- postgresql (>= 1.0.0)
- ssl_certificate
- yum-epel
Required Applications
- Ruby
1.9.3
or higher.
Other Requirements
On RedHat based platforms, you need to disable or configure SELinux correctly to work with mysql
cookbook. You can use the selinux::disabled
recipe for that.
Generated Passwords
The first time it runs, automatically generates some passwords if not specified. Generated passwords are:
From the PostfixAdmin Default Recipe
postfixadmin/setup_password
postfixadmin/setup_password_salt
postfixadmin/setup_password_encrypted
postfixadmin/database/password
When MySQL Is Used
postfixadmin/mysql/server_root_password
When PostgreSQL Is Used
postgresql/password/postgres
Attributes
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>node['postfixadmin']['version']</code></td>
<td>PostfixAdmin version</td>
<td><code>"2.3.7"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['url']</code></td>
<td>PostfixAdmin download URL</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['checksum']</code></td>
<td>PostfixAdmin download file checksum</td>
<td><code>"761074e711ab618deda425dc013133b9d5968e0859bb883f10164061fd87006e"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['port']</code></td>
<td>PostfixAdmin listen port</td>
<td><em>calculated: </em><code>"80"</code><em> or </em><code>"443"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['server_name']</code></td>
<td>PostfixAdmin server name</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['server_aliases']</code></td>
<td>PostfixAdmin server aliases</td>
<td><code>[]</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['headers']</code></td>
<td>PostfixAdmin HTTP headers to set as hash</td>
<td><code>{}</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['ssl']</code></td>
<td>enables HTTPS (with SSL)</td>
<td><code>false</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['encrypt_attributes']</code></td>
<td>Whether to encrypt PostfixAdmin attributes containing credential secrets.</td>
<td><code>false</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['setup_password']</code></td>
<td>PostfixAdmin Setup Password (required for chef-solo)</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['setup_password_salt']</code></td>
<td>PostfixAdmin password salt (required for chef-solo)</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['web_server']</code></td>
<td>Web server to use: <code>"apache"</code>, <code>"nginx"</code> or <code>false</code></td>
<td><code>"apache"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['setup_password_encrypted']</code></td>
<td>PostfixAdmin encrypted Password</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['database']['type']</code></td>
<td>PostfixAdmin database type. Possible values are: <code>"mysql"</code>, <code>"postgresql" (Please, see <a href="#postgresql-support">below<a/>)</code></td>
<td><code>"mysql"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['database']['name']</code></td>
<td>PostfixAdmin database name</td>
<td><code>"postfix"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['database']['host']</code></td>
<td>PostfixAdmin database hostname or IP address</td>
<td><code>"127.0.0.1"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['database']['user']</code></td>
<td>PostfixAdmin database login username</td>
<td><code>"postfix"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['database']['password']</code></td>
<td>PostfixAdmin database login password (requried for chef-solo)</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['mysql']['instance']</code></td>
<td>PostfixAdmin MySQL instance name to run by the mysql_service LWRP from the mysql cookbook</td>
<td><code>'default'</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['mysql']['data_dir']</code></td>
<td>PostfixAdmin MySQL data files path</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['mysql']['port']</code></td>
<td>PostfixAdmin MySQL port</td>
<td><code>'3306'</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['mysql']['run_group']</code></td>
<td>PostfixAdmin MySQL system group</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['mysql']['run_user']</code></td>
<td>PostfixAdmin MySQL system user</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['mysql']['version']</code></td>
<td>PostfixAdmin database MySQL version to install</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['conf']['encrypt']</code></td>
<td>The way do you want the passwords to be crypted</td>
<td><code>"md5crypt"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['conf']['domain_path']</code></td>
<td>Whether you want to store the mailboxes per domain</td>
<td><code>"YES"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['conf']['domain_in_mailbox']</code></td>
<td>Whether you want to have the domain in your mailbox</td>
<td><code>"NO"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['conf']['fetchmail']</code></td>
<td>Whether you want fetchmail tab</td>
<td><code>"NO"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['packages']['requirements']</code></td>
<td>PostfixAdmin required packages array</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['packages']['mysql']</code></td>
<td>PostfixAdmin required packages array for MySQL support</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['packages']['postgresql']</code></td>
<td>PostfixAdmin required packages array for PostgreSQL support</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node["boxbilling"]["mysql"]["server_root_password"]</code></td>
<td>PostfixAdmin MySQL <em>root</em> password.</td>
<td><em>calculated</em></td>
</tr>
<tr>
<td><code>node['postfixadmin']['map_files']['path']</code></td>
<td>Path to generate map-files into</td>
<td><code>"/etc/postfix/tables"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['map_files']['mode']</code></td>
<td>Map-files file-mode bits</td>
<td><code>00640</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['map_files']['owner']</code></td>
<td>Map-files files owner</td>
<td><code>"root"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['map_files']['group']</code></td>
<td>Map-files files group</td>
<td><code>"postfix"</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['map_files']['list']</code></td>
<td>An array with map file names to generate</td>
<td><code>[<br/>
"db_virtual_alias_maps.cf",<br/>
"db_virtual_alias_domain_maps.cf",<br/>
"db_virtual_alias_domain_catchall_maps.cf",<br/>
"db_virtual_domains_maps.cf",<br/>
"db_virtual_mailbox_maps.cf",<br/>
"db_virtual_alias_domain_mailbox_maps.cf",<br/>
"db_virtual_mailbox_limit_maps.cf"<br/>
]</code></td>
</tr>
<tr>
<td><code>node['postfixadmin']['php-fpm']['pool']</code></td>
<td>PHP-FPM pool name to use with PostfixAdmin.</code></td>
<td><code>'postfixadmin'</code></td>
</tr>
</table>
The HTTPS Certificate
This cookbook uses the ssl_certificate
cookbook to create the HTTPS certificate. The namespace used is node['postfixadmin']
. For example:
node.default['postfixadmin']['common_name'] = 'postfixadmin.example.com' include_recipe 'postfixadmin'
See the ssl_certificate
namespace documentation for more information.
Encrypted Attributes
This cookbook can use the encrypted_attributes cookbook to encrypt the secrets generated during the Chef Run. This feature is disabled by default, but can be enabled setting the node["postfixadmin"]["encrypt_attributes"]
attribute to true
. For example:
include_recipe 'encrypted_attributes::users_data_bag' node.default['postfixadmin']['encrypt_attributes'] = true inclure_recipe 'postfixadmin'
This will create the following encrypted attributes:
-
node['postfixadmin']['setup_password']
: PostfixAdmin setup.php setup password. -
node['postfixadmin']['setup_password_encrypted']
: PostfixAdmin setup.php setup password encrypted with a salt. -
node['postfixadmin']['mysql']['server_root_password']
: MySQL root user password. -
node['postfixadmin']['database']['password']
: MySQL PostfixAdmin user password.
Read the chef-encrypted-attributes
gem documentation to learn how to read them.
Warning: When PostgreSQL is used, the database root password will still remain unencrypted in the node['postgresql']['password']['postgres']
attribute due to limitations of the postgresql cookbook.
Recipes
postfixadmin::default
Installs and configures PostfixAdmin.
postfixadmin::map_files
Installs PostfixAdmin SQL map files to be used by Postfix.
postfixadmin::mysql
Installs MySQL server for PostfixAdmin.
postfixadmin::postgresql
Installs PostgreSQL server for PostfixAdmin.
Resources
postfixadmin_admin[user]
Create or remove a PostfixAdmin admin user. This kind of user is used to create the domains and mailboxes.
postfixadmin_admin Actions
-
create
: Create a PostfixAdmin admin user (default). -
remove
: Remove a PostfixAdmin admin user.
postfixadmin_admin Parameters
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>user</td>
<td>Username</td>
<td><em>name attribute</em></td>
</tr>
<tr>
<td>password</td>
<td>Password</td>
<td><code>"p@ssw0rd1"</code></td>
</tr>
<tr>
<td>setup_password</td>
<td>PostfixAdmin Setup Password</td>
<td><code>node['postfixadmin']['setup_password']</code></td>
</tr>
<tr>
<td>db_user</td>
<td>Database username</td>
<td><code>node['postfixadmin']['database']['user']</code></td>
</tr>
<tr>
<td>db_password</td>
<td>Database password</td>
<td><code>node['postfixadmin']['database']['password']</code></td>
</tr>
<tr>
<td>db_name</td>
<td>Database name</td>
<td><code>node['postfixadmin']['database']['name']</code></td>
</tr>
<tr>
<td>db_host</td>
<td>Database hostname</td>
<td><code>node['postfixadmin']['database']['host']</code></td>
</tr>
<tr>
<td>ssl</td>
<td>Whether to use SSL on HTTP requests</td>
<td><code>node['postfixadmin']['ssl']</code></td>
</tr>
</table>
postfixadmin_admin Example
postfixadmin_admin 'admin@admindomain.com' do password 'sup3r-s3cr3t-p4ss' action :create end
postfixadmin_domain[domain]
Create domains.
postfixadmin_domain Actions
create
postfixadmin_domain Parameters
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>domain</td>
<td>Domain name</td>
<td><em>name attribute</em></td>
</tr>
<tr>
<td>description</td>
<td>Domain description</td>
<td><code>""</code></td>
</tr>
<tr>
<td>aliases</td>
<td>Maximum number of aliases</td>
<td><code>10</code></td>
</tr>
<tr>
<td>mailboxes</td>
<td>Maximum number of mailboxes</td>
<td><code>10</code></td>
</tr>
<tr>
<td>login_username</td>
<td>Admin user to use</td>
<td><em>required</em></td>
</tr>
<tr>
<td>login_password</td>
<td>Admin password </td>
<td><em>required</em></td>
</tr>
<tr>
<td>db_user</td>
<td>Database username</td>
<td><code>node['postfixadmin']['database']['user']</code></td>
</tr>
<tr>
<td>db_password</td>
<td>Database password</td>
<td><code>node['postfixadmin']['database']['password']</code></td>
</tr>
<tr>
<td>db_name</td>
<td>Database name</td>
<td><code>node['postfixadmin']['database']['name']</code></td>
</tr>
<tr>
<td>db_host</td>
<td>Database hostname</td>
<td><code>node['postfixadmin']['database']['host']</code></td>
</tr>
<tr>
<td>ssl</td>
<td>Whether to use SSL on HTTP requests</td>
<td><code>node['postfixadmin']['ssl']</code></td>
</tr>
</table>
postfixadmin_domain Example
# admin user copied from the previous example postfixadmin_domain 'foobar.com' do login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end
postfixadmin_mailbox[mailbox]
Create a mailbox.
postfixadmin_mailbox Actions
create
postfixadmin_mailbox Parameters
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>mailbox</td>
<td>Mailbox address to create</td>
<td><em>name attribute</em></td>
</tr>
<tr>
<td>password</td>
<td>Mailbox password</td>
<td><em>required</em></td>
</tr>
<tr>
<td>name</td>
<td>The name of the mailbox owner</td>
<td><code>""</code></td>
</tr>
<tr>
<td>active</td>
<td>Active status</td>
<td><code>true</code></td>
</tr>
<tr>
<td>mail</td>
<td>Whether to send a welcome email</td>
<td><code>false</code></td>
</tr>
<tr>
<td>login_username</td>
<td>Admin user to use</td>
<td><em>required</em></td>
</tr>
<tr>
<td>login_password</td>
<td>Admin password </td>
<td><em>required</em></td>
</tr>
<tr>
<td>db_user</td>
<td>Database username</td>
<td><code>node['postfixadmin']['database']['user']</code></td>
</tr>
<tr>
<td>db_password</td>
<td>Database password</td>
<td><code>node['postfixadmin']['database']['password']</code></td>
</tr>
<tr>
<td>db_name</td>
<td>Database name</td>
<td><code>node['postfixadmin']['database']['name']</code></td>
</tr>
<tr>
<td>db_host</td>
<td>Database hostname</td>
<td><code>node['postfixadmin']['database']['host']</code></td>
</tr>
<tr>
<td>ssl</td>
<td>Whether to use SSL on HTTP requests</td>
<td><code>node['postfixadmin']['ssl']</code></td>
</tr>
</table>
postfixadmin_mailbox Example
# admin user copied from the previous example postfixadmin_mailbox 'bob@foobar.com' do password 'alice' login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end
postfixadmin_alias[address]
Create mailbox aliases.
postfixadmin_alias Actions
create
postfixadmin_alias Parameters
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>address</td>
<td>Alias address</td>
<td><em>name attribute</em></td>
</tr>
<tr>
<td>goto</td>
<td>Destination mailbox address</td>
<td><em>required</em></td>
</tr>
<tr>
<td>active</td>
<td>Active status</td>
<td><code>true</code></td>
</tr>
<tr>
<td>login_username</td>
<td>Admin user to use</td>
<td><em>required</em></td>
</tr>
<tr>
<td>login_password</td>
<td>Admin password </td>
<td><em>required</em></td>
</tr>
<tr>
<td>db_user</td>
<td>Database username</td>
<td><code>node['postfixadmin']['database']['user']</code></td>
</tr>
<tr>
<td>db_password</td>
<td>Database password</td>
<td><code>node['postfixadmin']['database']['password']</code></td>
</tr>
<tr>
<td>db_name</td>
<td>Database name</td>
<td><code>node['postfixadmin']['database']['name']</code></td>
</tr>
<tr>
<td>db_host</td>
<td>Database hostname</td>
<td><code>node['postfixadmin']['database']['host']</code></td>
</tr>
<tr>
<td>ssl</td>
<td>Whether to use SSL on HTTP requests</td>
<td><code>node['postfixadmin']['ssl']</code></td>
</tr>
</table>
postfixadmin_alias Example
# admin user copied from the previous example postfixadmin_alias 'billing@foobar.com' do goto 'bob@foobar.com' login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end
postfixadmin_alias_domain[address]
Create domain aliases. The alias_domain
must already exist.
postfixadmin_alias_domain Actions
create
postfixadmin_alias_domain Parameters
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>alias_domain</td>
<td>Alias domain</td>
<td><em>name attribute</em></td>
</tr>
<tr>
<td>target_domain</td>
<td>Target domain</td>
<td><em>required</em></td>
</tr>
<tr>
<td>active</td>
<td>Active status</td>
<td><code>true</code></td>
</tr>
<tr>
<td>login_username</td>
<td>Admin user to use</td>
<td><em>required</em></td>
</tr>
<tr>
<td>login_password</td>
<td>Admin password </td>
<td><em>required</em></td>
</tr>
<tr>
<td>db_user</td>
<td>Database username</td>
<td><code>node['postfixadmin']['database']['user']</code></td>
</tr>
<tr>
<td>db_password</td>
<td>Database password</td>
<td><code>node['postfixadmin']['database']['password']</code></td>
</tr>
<tr>
<td>db_name</td>
<td>Database name</td>
<td><code>node['postfixadmin']['database']['name']</code></td>
</tr>
<tr>
<td>db_host</td>
<td>Database hostname</td>
<td><code>node['postfixadmin']['database']['host']</code></td>
</tr>
<tr>
<td>ssl</td>
<td>Whether to use SSL on HTTP requests</td>
<td><code>node['postfixadmin']['ssl']</code></td>
</tr>
</table>
postfixadmin_alias_domain Example
# admin user copied from the previous example postfixadmin_alias_domain 'aliasdomain.com' do target_domain 'foobar.com' login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end
Usage Example
Including in a Cookbook Recipe
A complete example:
include_recipe 'postfixadmin::default' include_recipe 'postfixadmin::map_files' # or include them in your run-list postfixadmin_admin 'admin@admindomain.com' do password 'sup3r-s3cr3t-p4ss' action :create end postfixadmin_domain 'foobar.com' do login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end postfixadmin_mailbox 'bob@foobar.com' do password 'alice' login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end postfixadmin_alias 'billing@foobar.com' do goto 'bob@foobar.com' login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end postfixadmin_alias_domain 'aliasdomain.com' do target_domain 'foobar.com' login_username 'admin@admindomain.com' login_password 'sup3r-s3cr3t-p4ss' end
Don't forget to include the postfixadmin
cookbook as a dependency in the metadata.
# metadata.rb # [...] depends 'postfixadmin'
Including in the Run List
Another alternative is to include the recipes in your Run List.
{ "name": "mail.onddo.com", [...] "run_list": [ [...] "recipe[postfixadmin]", "recipe[postfixadmin::map_files]" ] }
PostgreSQL Support
PostfixAdmin with PostgreSQL may not work properly on some platforms: See for example postgresql
cookbook issue #249. Any feedback you can provide regarding the PostgreSQL support will be greatly appreciated.
PostgreSQL Support on Debian and Ubuntu
Due to postgresql
cookbook issue #108, you should configure your system locale correctly for PostgreSQL to work. You can use the locale
cookbook to fix this. For example:
ENV['LANGUAGE'] = ENV['LANG'] = node['locale']['lang'] ENV['LC_ALL'] = node['locale']['lang'] include_recipe 'locale' # ... node.default['postfixadmin']['database']['type'] = 'postgresql' include_recipe 'postfixadmin'
PostgreSQL Versions < 9.3
If you are using PostgreSQL version < 9.3
, you may need to adjust the shmmax
and shmall
kernel parameters to configure the shared memory. You can see [the example used for the integration tests](test/cookbooks/postfixadmin_test/recipes/_postgresql_memory.rb).
Testing
See TESTING.md.
ChefSpec Matchers
postfixadmin_admin(user)
Helper method for locating a postfixadmin_admin
resource in the collection.
resource = chef_run.postfixadmin_admin(user) expect(resource).to notify('service[apache2]').to(:reload)
create_postfixadmin_admin(user)
Assert that the Chef Run creates a PostfixAdmin admin user.
expect(chef_run).to create_postfixadmin_admin(user)
remove_postfixadmin_admin(path)
Assert that the Chef Run removes a PostfixAdmin admin user.
expect(chef_run).to remove_postfixadmin_admin(user)
postfixadmin_alias(address)
Helper method for locating a postfixadmin_alias
resource in the collection.
resource = chef_run.postfixadmin_alias(address) expect(resource).to notify('service[apache2]').to(:reload)
create_postfixadmin_alias(address)
Assert that the Chef Run creates a PostfixAdmin alias.
expect(chef_run).to create_postfixadmin_alias(address)
postfixadmin_alias_domain(alias_domain)
Helper method for locating a postfixadmin_alias_domain
resource in the collection.
resource = chef_run.postfixadmin_alias_domain(alias_domain) expect(resource).to notify('service[apache2]').to(:reload)
create_postfixadmin_alias_domain(alias_domain)
Assert that the Chef Run creates a PostfixAdmin alias domain.
expect(chef_run).to create_postfixadmin_alias_domain(alias_domain)
postfixadmin_domain(domain)
Helper method for locating a postfixadmin_domain
resource in the collection.
resource = chef_run.postfixadmin_domain(domain) expect(resource).to notify('service[apache2]').to(:reload)
create_postfixadmin_domain(domain)
Assert that the Chef Run creates a PostfixAdmin domain.
expect(chef_run).to create_postfixadmin_domain(domain)
postfixadmin_mailbox(mailbox)
Helper method for locating a postfixadmin_mailbox
resource in the collection.
resource = chef_run.postfixadmin_domain(mailbox) expect(resource).to notify('service[apache2]').to(:reload)
create_postfixadmin_mailbox(mailbox)
Assert that the Chef Run creates a PostfixAdmin mailbox.
expect(chef_run).to create_postfixadmin_mailbox(mailbox)
Contributing
Please do not hesitate to open an issue with any questions or problems.
See CONTRIBUTING.md.
TODO
See TODO.md.
License and Author
Author: | Xabier de Zuazo (xabier@onddo.com) |
Contributor: | chrludwig |
Contributor: | MATSUI Shinsuke (poppen) |
Contributor: | Brian Racer |
Contributor: | Bernhard Weisshuhn (a.k.a. bernhorst) |
Copyright: | Copyright (c) 2013-2015 Onddo Labs, SL. (www.onddo.com) |
License: | Apache License, Version 2.0 |
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
Contingent cookbooks
CHANGELOG for postfixadmin
This file is used to list changes made in each version of postfixadmin
.
v2.0.0 (2015-05-09)
-
Update the cookbook and the dependencies (breaking change):
- Update
mysql
cookbook to version6
. - Update
database
cookbook to version4
. - Update resources to use
mysql2
gem. - Improve nginx support:
- Restart nginx and php-fpm on first run for LWRP to work properly.
- Fix php-fpm support on Ubuntu
10
.
- Update
-
Testing:
- Clean up the cookbook used for integration tests.
- Update kitchen.yml file.
- Gemfile:
- Add ohai
< 8
for ruby< 2
. - Update RuboCop to
0.30.1
.
Upgrading from a 1.x.y
Cookbook Release
Note: Please do this with caution. Make a full backup before upgrading.
If you want to upgrade the cookbook version from a 1.x
release, you should change the MySQL data directory path to the old one (or migrate the database by hand):
node.default['postfixadmin']['mysql']['data_dir'] = '/var/lib/mysql' # [...] include_recipe 'postfixadmin'
v1.4.2 (2015-05-07)
- Mailbox resource: Fix name attribute to be a string.
v1.4.1 (2015-05-06)
- Monkey patch the
MysqlClient#version
method missing error.
v1.4.0 (2015-02-13)
- Fix disabling nginx default site.
- Remove
ssl_ca
param fromweb_app
template. - Include specific helpers instead of
"database::#{type}"
(issue #5, thanks Bernhard Weisshuhn (a.k.a. bernhorst)).- Fixes
database
cookbook version4
support.
- Fixes
- Run Unit tests against Chef
11
and12
. - Gemfile: Update RuboCop to
0.29.0
.
v1.3.0 (2015-01-05)
- Add nginx support.
- Update
ssl_certificate
cookbook to1.1.0
, adds chained certificate support. - metadata: use pessimistic operator for cookbook versions, fixes database version bug.
- Bugfix: include OpenSSL functions in the
::postgresql
recipe. - Berksfile: Use ark stable version for tests.
- Unit Tests: Update to use
ChefSpec::ServerRunner
. - Fix Serverspec integration tests.
- travis.yml: Use the new build env.
- Gemfile:
- Use foodcritic and RuboCop fixed versions.
- Update to RuboCop
0.28.0
. - Update vagrant-wrapper to
2
.
- README:
- Move the test matchers documentation to the README.
- Add TOC.
- s/Attribute/Parameter/ for resources.
- TODO: add mysql cookbook update task.
v1.2.0 (2014-11-09)
- ChefSpec matchers: added helper methods to locate LWRP resources.
-
PostfixAdmin::DB
: allowdb
instance attribute to be readable. - Fix providers and map files password decryption with encrypted attributes enabled.
- Fix new RuboCop offense.
- Tests integrated with
should_not
gem. - Update tests to work with Serverspec 2, includes Gemfile.
- Berksfile, Rakefile and Guarfile, generic templates copied.
- Enable ChefSpec coverage.
- TODO.md: Add some tasks.
- Homogenize license headers.
v1.1.0 (2014-10-03)
- Added depends
mysql
cookbook~> 5.0
. - Include PHP recipe to fix Fedora support.
- Added LICENSE file.
- travis.yml: exclude some groups from bundle install.
- Gemfile:
- Replaced
vagrant
git byvagrant-wrapper
. - Berkshelf updated to
3.1
.
- Replaced
- Rakefile: require kitchen inside integration task.
- Guardfile added.
- Vagrantfile updated to work properly and documented in TESTING.
- PostgreSQL support improved and documented.
- Added Serverspec tests.
- Set
PATH
for bats integration tests to avoid$LSOF
monkey-patch. - Some integration tests improved.
v1.0.1 (2014-09-14)
- Do not include
mysql::server
recipe. - Added MySQL attributes documentation.
- PostgreSQL password generation moved to
recipe::postgresql
. - README: generated password documentation fixed.
- Added Fedora and Amazon Linux support.
v1.0.0 (2014-09-14)
- Fixed Apache
2.4
support. - FC001: Use strings in preference to symbols to access node attributes.
- FC023: Prefer conditional attributes.
- kitchen.yml: updated, some syntax improvements, added apt to the run list.
- kitchen.yml: added hostname and forwarded ports.
- Added .kitchen.cloud.yml file.
- test/kitchen/cookbooks directory moved to test/cookbooks.
- Gemfile updated and improved.
- Added a TODO file.
- Integrated with
ssl_certificate
cookbook and some related improvements:- Update Warning: This update will cause the self-signed certificate to be regenerated.
- Added
server_aliases
attribute. - Added
headers
attribute. - Fixed SSL support in CentOS.
- Both 80 and 443 ports remain enabled with SSL.
- Update Warning: Log files path changed from postfix_access.log and postfix_ssl_access.log to postfix-access.log and postfix-ssl-access.log (the same applies applies to error logs).
- Replaced
return
s in providers bynext
s. - Fixed apache restart for LWRPs.
-
web_app-postfixadmin-reload
resource for LWRPs after VirtualHost creation. - All RuboCop offenses fixed, Rakefile added.
- Library methods changed from
camelCase
tosnake_case
. -
exists?
library methods renamed toexist?
. - Replaced
Chef::Application.fatal
by exceptions: avoids daemon exit. - Fixed map-files integration tests.
- Library methods changed from
-
PostfixAdmin::MySQL
refactored: removed code duplication and logger configured. -
PostfixAdmin::PHP
code duplication removed. - Added PostgreSQL support (based on @anveo's work, thanks!), including:
-
PostfixAdmin::MySQL
library renamed toPostfixAdmin::DB
. - PostfixAdmin HTML error parsing improved.
- Required packages installation refactored using attributes.
- Fixed config.local.php group value without apache.
-
- All integration tests fixed to pass.
- Added listening port attribute:
- Update Warning: Only one port will be enabled by default at the same time (no more non-SSL + SSL combo).
- Added ChefSpec matchers.
- Added ChefSpec tests.
- Added travis.yml and multiple badges.
- README: updated a paragraph about database support.
- README: separated into multiple files and some titles fixed.
-
recipes::apache
: fixed disablingweb_app[postfixadmin-ssl]
. - Integrated with
encrypted_attributes
cookbook:- FC007: Ensure recipe dependencies are reflected in cookbook metadata.
- attributes: disable
encrypt_attributes
by default.
- Create MySQL database only for localhost.
v0.2.0 (2014-05-24)
- Default PostfixAdmin version updated to
2.3.7
. -
server_name
attribute calculated. - README: Added requirements links.
- README: Added Cookbook Badge.
- README: some
alias_domain
titles fixed. - Added
postfixadmin_alias_domain
LWRP. - Added Serverspec tests (issue #4, thanks MATSUI Shinsuke (poppen)).
- Separate recipe for apache (issue #4, thanks MATSUI Shinsuke (poppen)).
- Gemfile: switch to using the new version of vagrant (issue #4, thanks MATSUI Shinsuke (poppen)).
- kitchen.yml: updated to latest format.
v0.1.3 (2014-03-16)
v0.1.2 (2013-11-17)
- Fixed compatibility issues with Chef 11.8 (issue #1, thanks mikelococo for reporting).
- LWRPs fixed to notify only when an action is executed.
v0.1.1 (2013-10-28)
- metadata: provides without square brackets to avoid CHEF-3976
v0.1.0 (2013-06-11)
- Initial release of
postfixadmin
Foodcritic Metric
2.0.0 passed this metric
2.0.0 passed this metric