README

About postfixADM

postfixADM is a modern postfix management tool. It is designed to work with almost any setup that is based on postfix, dovecot and mysql.

Some of the key features are:

• Easy web installation and setup
• Fully responsive
• Database mapping
• Supports over 22 crypto algorithms
• Mailbox management
• Alias management
• Domain management
• Optional Quota-Service
• User management & ACL
• System updater integrated
• English and German language supported

Based on:

• Laravel 5.4
• AngularJS 1.6
• Angular Material

Requirements:

• MySQL
• PHP 5.6
• Apache2 or Nginx 1.6
• doveadm (dovecot-core)

Developed and compiled with:

• Gulp
• Bower
• Composer
• NPM / NodeJS

Fore more information please visit: https://www.postfixadm.com

Screenshots

Getting started

The easy way

Download the newest version at: https://www.postfixadm.com/download and unzip the content to where ever you want it to be.

The other way

If you like you can build your own installation package from this source:

$ git clone https://github.com/Webklex/postfixadm.git
$ cd postfixadm
$ composer install
$ php artisan update --init
$ cp gulp.env.example gulp.env

Open gulp.env and enter your environment name and development domain.

$ npm install
$ bower install
$ gulp && gulp watch

Optional: Quota service

If you like you can enable a quota service which allows you to keep an eye on your mailbox quota usage. Please refer to https://www.postfixadm.com/wiki/setup/quota_service for more details.

Development

Copy the file gulp.env.example to gulp.env and edit the containing variables. Now you can install the development components:

$ npm install
$ bower install

You can bake everything together with the gulp command. If you want to develop a bit more fluent just use gulp watch instead.

Currently known Issues

• Missing or weird translations (please let me know if you find any - you'll get a cookie as well).
• Uncommented code sections.
• The code is not optimized.
• (inactive @postfixadm.com mail addresses - please use github[at]webklex.com for now)
• And probably some more... But besides that it works like a charm :)

Contributing

Thank you for considering contributing to postfixADM! The contribution guide will be added later ;)

Security Vulnerabilities

If you discover a security vulnerability within postfixADM, please send an e-mail to me at security@postfixadm.com. All security vulnerabilities will be promptly addressed.

License

postfixADM is open-sourced software and licensed under MIT.