cookbook 'codenamephp_localmail', '= 3.1.0'
The codenamephp_localmail cookbook has been deprecated
Author provided reason for deprecation:
The codenamephp_localmail cookbook has been deprecated and is no longer being maintained by its authors. Use of the codenamephp_localmail cookbook is no longer recommended.
codenamephp_localmail (9) Versions 3.1.0 Follow0
Cookbook that installs a local mailserver and mail client for local only mail used during development
cookbook 'codenamephp_localmail', '= 3.1.0', :supermarket
knife supermarket install codenamephp_localmail
knife supermarket download codenamephp_localmail
Chef Cookbook Localmail
Cookbook that installs a local mailserver and mail client for local only mail used during development.
Requirements
Supported Platforms
- Debian Buster (probably works with older versions as well)
Chef
- Chef 13.0+
Cookbook Depdendencies
- apt
- codenamephp_docker
Usage
Add the cookbook to your Berksfile:
cookbook 'codenamephp_localmail'
Build a wrapper cookbook and use the resources as needed.
Resources
Mailhog
Mailhog is a mail trap for local development. It offers a nice
web UI and also advanced features like a JSON REST API.
This resource installs mailhog as docker container to avoid any other
build or runtime dependencies (short of docker of course, but chances are
docker is already used).
It also install a custom sendmail script that relays the calls to the
sendmail within the docker container.
Properties
-
webui_port
(Integer): The port on the host whre the web ui will be available at, defaults to8025
-
sendmail_install_path
(String): The path to where the custom sendmail is installed to, defaults to/usr/sbin/sendmail
Examples
With minimal properties:
```ruby
Install
codenamephp_localmail_mailhog 'install mailhog'
Uninstall
codenamephp_localmail_mailhog 'uninstall mailhog' do
action :uninstall
end
ruby
With custom port and path:
Install
codenamephp_localmail_mailhog 'install mailhog' do
webui_port 1234
sendmail_install_path '/some/other/path'
end
Uninstall - webui_port is not relevant here
codenamephp_localmail_mailhog 'uninstall mailhog' do
sendmail_install_path '/some/ohter/path'
end
```
Dependent cookbooks
apt >= 0.0.0 |
codenamephp_docker ~>1.0.0 |
docker ~>4.12 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
3.1.0 (2020-03-01)
Closed issues:
- Use sendmail from docker instead of extra mhsendmail #14
v3.0.1 (2020-03-01)
Closed issues:
Merged pull requests:
- [RELEASE 3.0.1] #13 (bastianschwarz)
- [RELEASE 3.0.0] #12 (bastianschwarz)
v2.0.0 (2018-09-13)
Implemented enhancements:
- Switch to postfix again ... #3
Merged pull requests:
- [RELEASE 2.0.0] #7 (bastianschwarz)
- [RELEASE 2.0.0] #5 (bastianschwarz)
v1.0.1 (2018-09-08)
Merged pull requests:
- [RELEASE 1.0.1] #2 (bastianschwarz)
v1.0.0 (2018-09-08)
Merged pull requests:
- [RELEASE 1.0.0] #1 (bastianschwarz)
* This Changelog was automatically generated by github_changelog_generator
Collaborator Number Metric
3.1.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
3.1.0 passed this metric
No Binaries Metric
3.1.0 passed this metric
Testing File Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
3.1.0 failed this metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
3.1.0 passed this metric
No Binaries Metric
3.1.0 passed this metric
Testing File Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
3.1.0 passed this metric
3.1.0 passed this metric
Testing File Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
3.1.0 failed this metric
3.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number