diff --git a/README.md b/README.md index ac0325c9..200d3728 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ * Documents are all licensed under [Creative Commons](http://creativecommons.org/). # Install iRedMail +* [Install iRedMail on Debian Linux](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/install.iredmail.on.debian.md) * [Install iRedMail on Red Hat Enterprise Linux, CentOS](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/install.iredmail.on.rhel.md) * [Setup DNS records for your iRedMail server](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/setup_dns.md) * [Perform silent/unattended iRedMail installation](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/unattended.iredmail.installation.md) diff --git a/TODO.md b/TODO.md index e836e553..cd870263 100644 --- a/TODO.md +++ b/TODO.md @@ -4,8 +4,8 @@ * How to enable per-recipient policy lookup in Amavisd (@lookup_sql_dsn). * How to enable DNSBL in Postfix. -* How to sign DKIM signature on sent emails for new mail domain. mention how - to use one DKIM key for all domains. +* ~~ How to sign DKIM signature on sent emails for new mail domain. mention how + to use one DKIM key for all domains. ~~ # installation guides diff --git a/html/index.html b/html/index.html index ee91b330..ee4da66d 100644 --- a/html/index.html +++ b/html/index.html @@ -14,6 +14,7 @@

Install iRedMail

@@ -41,21 +40,17 @@ and configure them for you automatically. Otherwise it may override your existing files/configurations althought it will backup files before modifing, and it may be not working as expected.

-

To install iRedMail, you need:

+

To install iRedMail on RHEL or CentOS Linux, you need:

Preparations

Set a fully qualified domain name (FQDN) hostname on your server

-

No matter your server is a testing machine or production server, we strongly -recommended you to set a fully qualified domain name (FQDN) hostname.

+

No matter your server is a testing machine or production server, it's strongly +recommended to set a fully qualified domain name (FQDN) hostname.

Enter command hostname -f to view the current hostname:

$ hostname -f
 mx.example.com
@@ -73,9 +68,9 @@ mx.example.com
 
-
127.0.0.1   mx.example.com demo localhost localhost.localdomain
+
127.0.0.1   mx.example.com mx localhost localhost.localdomain
 

Verify the FQDN hostname. If it wasn't changed, please reboot server to make it work.

@@ -135,50 +130,55 @@ questions, that's all steps to setup a full-featured mail server.

Screenshots of installation:

-
    +
+

-
    +
+

-
    +
+

IMPORTANT NOTE: There's no big difference between available backends, so it's strongly recommended to choose the one you're familiar with for easier management and maintenance after installation.

-
    -
  1. If you choose to store mail accounts in OpenLDAP, iRedMail installer will -ask you two questions about OpenLDAP.
  2. -
-

4.1. LDAP suffix.

+

-

4.2. Password of LDAP root dn.

+
* Password of LDAP root dn.
+

-
    +
+

NOTE: MySQL is used to store data of other applications (e.g. Roundcube webmail, Cluebringer, Amavisd-new) if you choose OpenLDAP or MySQL as backend.

-
    +
+

-
    +
+

Note: This account is an admin account and a mail user. That means you can login to webmail and admin panel (iRedAdmin) with this account, login username is full email address.

-
    +
+

After answered above questions, iRedMail installer will ask your confirm to start installation. It will install and configure required packages @@ -225,14 +225,6 @@ hostname or IP address.

Get technical support

Please post all issues, feedbacks, feature requests, suggestions in our online support forum, it's more responsible than you -expected.

-

Notes about binary packages provided by iRedMail project

-

Most binary packages in iRedMail yum repository comes from below repositories, -packages with -ired flag were packed by iRedMail project.

-

If you found something wrong +expected.


If you found something wrong in this document, please do contact us to fix it.

©© Creative Commons

\ No newline at end of file diff --git a/installation/install.iredmail.on.debian.md b/installation/install.iredmail.on.debian.md new file mode 100644 index 00000000..5462879e --- /dev/null +++ b/installation/install.iredmail.on.debian.md @@ -0,0 +1,207 @@ +# Install iRedMail on Debian Linux + +[TOC] + +## System Requirements + +> __WARNING__: iRedMail is designed to be deployed on a FRESH server system, +> which means your server does __NOT__ have mail related components installed, +> e.g. MySQL, OpenLDAP, Postfix, Dovecot, Amavisd, etc. iRedMail will install +> and configure them for you automatically. Otherwise it may override your +> existing files/configurations althought it will backup files before modifing, +> and it may be not working as expected. + +To install iRedMail on Debian Linux, you need: + +* A FRESH, working Debian Linux. Supported releases are listed on + [Download](../download.html) page. +* At least `1 GB` of memory is required for low traffic production server. + Spam/Virus scanning will take most system resource. + +Note: All binary packages will be installed from Debian official apt repositories. + +## Preparations + +### Set a fully qualified domain name (FQDN) hostname on your server + +No matter your server is a testing machine or production server, it's strongly +recommended to set a fully qualified domain name (FQDN) hostname. + +Enter command `hostname -f` to view the current hostname: + +```shell +$ hostname -f +mx.example.com +``` + +On Debian, hostname is set in two files: `/etc/hostname` and `/etc/hosts`. + +* `/etc/hostname`: short hostname, not FQDN. + +``` +mx +``` + +* `/etc/hosts`: static table lookup for hostnames. __Warning__: Please list the + FQDN hostname as first item. + +``` +# Part of file: /etc/hosts +127.0.0.1 mx.example.com mx localhost localhost.localdomain +``` + +Verify the FQDN hostname. If it wasn't changed after updating above two files, +please reboot server to make it work. + +``` +$ hostname -f +mx.example.com +``` + +### Enable default official Debian apt repositories + +* iRedMail needs official Debian apt repositories, please enable them in + `/etc/apt/sources.lists`. +* Install package `bzip2` so that you can uncompress downloaded iRedMail package. + +``` +# sudo apt-get install bzip2 +``` + +### Download the latest release of iRedMail + +* Visit [Download page](../download.html) to get the + latest stable release of iRedMail. + +* Upload iRedMail to your mail server via ftp or scp or whatever method you + can use, login to the server to install iRedMail. We assume you uploaded + it to `/root/iRedMail-x.y.z.tar.bz2` (replace x.y.z by the real version number). + +* Uncompress iRedMail tarball: + +``` +# cd /root/ +# tar xjf iRedMail-x.y.z.tar.bz2 +``` + +## Start iRedMail installer + +It's now ready to start iRedMail installer, it will ask you several simple +questions, that's all steps to setup a full-featured mail server. + +> For Chinese users: Our domain name "iredmail.org" is blocked in China mainland since Jun 04, 2011, please replace all 'iredmail.org' by its IP address "106.187.51.47" (without quotes) in /root/iRedMail-x.y.z/pkgs/get_all.sh BEFORE executing "iRedMail.sh". This is a Linode VPS hosted in Tokyo, Japan. + +``` +# cd /root/iRedMail-x.y.z/ +# bash iRedMail.sh +``` + +## Screenshots of installation: + +* Welcome and thanks for your use + +![](../images/installation/iredmail/welcome.png) + +* Specify location to store all mailboxes. Default is `/var/vmail/`. + +![](../images/installation/iredmail/location_to_store_mailboxes.png) + +* Choose backend used to store mail accounts. You can manage mail accounts +with iRedAdmin, our web-based iRedMail admin panel. + +__IMPORTANT NOTE__: There's no big difference between available backends, so +it's strongly recommended to choose the one you're familiar with for easier +management and maintenance after installation. + +![](../images/installation/iredmail/backend.png) + +* If you choose to store mail accounts in OpenLDAP, iRedMail installer will +ask you two questions about OpenLDAP. + +LDAP suffix. + +![](../images/installation/iredmail/ldap_suffix.png) + +Password of LDAP root dn. + +![](../images/installation/iredmail/pw_of_ldap_root_dn.png) + +* Set password of MySQL or PostgreSQL admin user. + +__NOTE__: MySQL is used to store data of other applications (e.g. Roundcube +webmail, Cluebringer, Amavisd-new) if you choose OpenLDAP or MySQL as backend. + +![](../images/installation/iredmail/pw_of_mysql_root_user.png) + +* Add your first mail domain name + +![](../images/installation/iredmail/first_mail_domain.png) + +* Set password of admin account of your first mail domain. + +__Note__: This account is an admin account and a mail user. That means you can +login to webmail and admin panel (iRedAdmin) with this account, login username +is full email address. + +![](../images/installation/iredmail/pw_of_domain_admin.png) + +* Choose optional components + +![](../images/installation/iredmail/optional_components.png) + + +After answered above questions, iRedMail installer will ask your confirm to +start installation. It will install and configure required packages +automatically. Type `y` or `Y` and press `Enter` to start. + +``` +Configuration completed. + +************************************************************************* +**************************** WARNING *********************************** +************************************************************************* +* * +* Please do remember to *REMOVE* configuration file after installation * +* completed successfully. * +* * +* * /root/iRedMail-x.y.z/config +* * +************************************************************************* +<<< iRedMail >>> Continue? [Y|n] # <- Type 'Y' or 'y' here, and press 'Enter' to continue +``` + +## Important things you __MUST__ know after installation + +* Read file `/root/iRedMail-x.y.z/iRedMail.tips` first, it contains: + + * URLs, usernames and passwords of web-based applications + * Location of mail serve related software configuration files + * Some other important and sensitive information + +* [Setup DNS records for your mail server](./setup_dns.html) + +## Access webmail and other web applications + +After installation successfully completed, you can access web-based programs +if you choose to install them. Replace `your_server` below by your real server +hostname or IP address. + +* __Roundcube webmail__: [https://your_server/mail/](https://your_server/mail/) +* __Web admin panel (iRedAdmin)__: [httpS://your_server/iredadmin/](httpS://your_server/iredadmin/) +* __phpLDAPadmin__ (available if you choose LDAP backend): [httpS://your_server/phpldapadmin/](httpS://your_server/phpldapadmin/) +* __Awstats__: [httpS://your_server/awstats/awstats.pl?config=web](httpS://your_server/awstats/awstats.pl?config=web) (or ?config=smtp) + +## Get technical support + +Please post all issues, feedbacks, feature requests, suggestions in our [online +support forum](http://www.iredmail.org/forum/), it's more responsible than you +expected. + +## Notes about binary packages provided by iRedMail project + +Most binary packages in iRedMail yum repository comes from below repositories, +packages with `-ired` flag were packed by iRedMail project. + +* [Dag Wieers](http://packages.sw.be/) +* [EPEL](http://download.fedora.redhat.com/pub/epel/) +* [ATrpms](http://atrpms.net/) diff --git a/installation/install.iredmail.on.rhel.md b/installation/install.iredmail.on.rhel.md index b1019495..fb8f0219 100644 --- a/installation/install.iredmail.on.rhel.md +++ b/installation/install.iredmail.on.rhel.md @@ -11,11 +11,10 @@ > existing files/configurations althought it will backup files before modifing, > and it may be not working as expected. -To install iRedMail, you need: +To install iRedMail on RHEL or CentOS Linux, you need: * A FRESH, working RHEL or CentOS system. Supported releases are listed on [Download](../download.html) page. - * At least `1 GB` of memory is required for low traffic production server. Spam/Virus scanning will take most system resource. @@ -23,8 +22,8 @@ To install iRedMail, you need: ### Set a fully qualified domain name (FQDN) hostname on your server -No matter your server is a testing machine or production server, we strongly -recommended you to set a fully qualified domain name (FQDN) hostname. +No matter your server is a testing machine or production server, it's strongly +recommended to set a fully qualified domain name (FQDN) hostname. Enter command `hostname -f` to view the current hostname: @@ -47,10 +46,10 @@ For RHEL/CentOS/Scientific Linux 7, hostname is defined in /etc/hostname. mx.example.com ``` -* /etc/hosts: hostname <=> IP address mapping. Warning: List the FQDN hostname as first item. +* `/etc/hosts`: hostname <=> IP address mapping. Warning: List the FQDN hostname as first item. ``` -127.0.0.1 mx.example.com demo localhost localhost.localdomain +127.0.0.1 mx.example.com mx localhost localhost.localdomain ``` Verify the FQDN hostname. If it wasn't changed, please reboot server to make it work. @@ -114,15 +113,15 @@ questions, that's all steps to setup a full-featured mail server. ## Screenshots of installation: -1. Welcome and thanks for your use +* Welcome and thanks for your use ![](../images/installation/iredmail/welcome.png) -2. Specify location to store all mailboxes. Default is `/var/vmail/`. +* Specify location to store all mailboxes. Default is `/var/vmail/`. ![](../images/installation/iredmail/location_to_store_mailboxes.png) -3. Choose backend used to store mail accounts. You can manage mail accounts +* Choose backend used to store mail accounts. You can manage mail accounts with iRedAdmin, our web-based iRedMail admin panel. __IMPORTANT NOTE__: There's no big difference between available backends, so @@ -131,29 +130,29 @@ management and maintenance after installation. ![](../images/installation/iredmail/backend.png) -4. If you choose to store mail accounts in OpenLDAP, iRedMail installer will +* If you choose to store mail accounts in OpenLDAP, iRedMail installer will ask you two questions about OpenLDAP. -4.1. LDAP suffix. + * LDAP suffix. ![](../images/installation/iredmail/ldap_suffix.png) -4.2. Password of LDAP root dn. + * Password of LDAP root dn. ![](../images/installation/iredmail/pw_of_ldap_root_dn.png) -5. Set password of MySQL or PostgreSQL admin user. +* Set password of MySQL or PostgreSQL admin user. __NOTE__: MySQL is used to store data of other applications (e.g. Roundcube webmail, Cluebringer, Amavisd-new) if you choose OpenLDAP or MySQL as backend. ![](../images/installation/iredmail/pw_of_mysql_root_user.png) -6. Add your first mail domain name +* Add your first mail domain name ![](../images/installation/iredmail/first_mail_domain.png) -7. Set password of admin account of your first mail domain. +* Set password of admin account of your first mail domain. __Note__: This account is an admin account and a mail user. That means you can login to webmail and admin panel (iRedAdmin) with this account, login username @@ -161,7 +160,7 @@ is full email address. ![](../images/installation/iredmail/pw_of_domain_admin.png) -8. Choose optional components +* Choose optional components ![](../images/installation/iredmail/optional_components.png) @@ -212,12 +211,3 @@ hostname or IP address. Please post all issues, feedbacks, feature requests, suggestions in our [online support forum](http://www.iredmail.org/forum/), it's more responsible than you expected. - -## Notes about binary packages provided by iRedMail project - -Most binary packages in iRedMail yum repository comes from below repositories, -packages with `-ired` flag were packed by iRedMail project. - -* [Dag Wieers](http://packages.sw.be/) -* [EPEL](http://download.fedora.redhat.com/pub/epel/) -* [ATrpms](http://atrpms.net/)