elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

New: install.iredmail.on.debian.md. 

Merge installation guide for Debian/Ubuntu.
This commit is contained in:
Zhang Huangbin 2014-10-11 13:50:41 +08:00
parent 203038c89c
commit 14e080d226
8 changed files with 530 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1,6 +1,7 @@
* Documents are all licensed under [Creative Commons](http://creativecommons.org/). * Documents are all licensed under [Creative Commons](http://creativecommons.org/).
# Install iRedMail # 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 Debian or Ubuntu Linux](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/install.iredmail.on.debian.ubuntu.md)
* [Install iRedMail on OpenBSD](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/install.iredmail.on.openbsd.md)
* [Install iRedMail on Red Hat Enterprise Linux, CentOS](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/install.iredmail.on.rhel.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) * [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) * [Perform silent/unattended iRedMail installation](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/unattended.iredmail.installation.md)

3
html/index.html
View File

@ -14,7 +14,8 @@
</ul> </ul>
<h3 id="install-iredmail">Install iRedMail</h3> <h3 id="install-iredmail">Install iRedMail</h3>
<ul> <ul>
<li><a href="install.iredmail.on.debian.html">Install iRedMail on Debian Linux</a></li> <li><a href="install.iredmail.on.debian.ubuntu.html">Install iRedMail on Debian or Ubuntu Linux</a></li>
<li><a href="install.iredmail.on.openbsd.html">Install iRedMail on OpenBSD</a></li>
<li><a href="install.iredmail.on.rhel.html">Install iRedMail on Red Hat Enterprise Linux, CentOS</a></li> <li><a href="install.iredmail.on.rhel.html">Install iRedMail on Red Hat Enterprise Linux, CentOS</a></li>
<li><a href="setup_dns.html">Setup DNS records for your iRedMail server</a></li> <li><a href="setup_dns.html">Setup DNS records for your iRedMail server</a></li>
<li><a href="unattended.iredmail.installation.html">Perform silent/unattended iRedMail installation</a></li> <li><a href="unattended.iredmail.installation.html">Perform silent/unattended iRedMail installation</a></li>

30
html/install.iredmail.on.debian.html → html/install.iredmail.on.debian.ubuntu.html
View File

@ -1,7 +1,7 @@
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Install iRedMail on Debian Linux</title> <title>Install iRedMail on Debian or Ubuntu Linux</title>
<link href="./css/markdown.css" rel="stylesheet"></head> <link href="./css/markdown.css" rel="stylesheet"></head>
</head> </head>
<body> <body>
@ -10,14 +10,14 @@
<a href="http://www.iredmail.org" target="_blank">iRedMail web site</a> <a href="http://www.iredmail.org" target="_blank">iRedMail web site</a>
// <a href="./index.html">Document Index</a> // <a href="./index.html">Document Index</a>
</div><h1 id="install-iredmail-on-debian-linux">Install iRedMail on Debian Linux</h1> </div><h1 id="install-iredmail-on-debian-or-ubuntu-linux">Install iRedMail on Debian or Ubuntu Linux</h1>
<div class="toc"> <div class="toc">
<ul> <ul>
<li><a href="#install-iredmail-on-debian-linux">Install iRedMail on Debian Linux</a><ul> <li><a href="#install-iredmail-on-debian-or-ubuntu-linux">Install iRedMail on Debian or Ubuntu Linux</a><ul>
<li><a href="#system-requirements">System Requirements</a></li> <li><a href="#system-requirements">System Requirements</a></li>
<li><a href="#preparations">Preparations</a><ul> <li><a href="#preparations">Preparations</a><ul>
<li><a href="#set-a-fully-qualified-domain-name-fqdn-hostname-on-your-server">Set a fully qualified domain name (FQDN) hostname on your server</a></li> <li><a href="#set-a-fully-qualified-domain-name-fqdn-hostname-on-your-server">Set a fully qualified domain name (FQDN) hostname on your server</a></li>
<li><a href="#enable-default-official-debian-apt-repositories">Enable default official Debian apt repositories</a></li> <li><a href="#enable-default-official-debianubuntu-apt-repositories">Enable default official Debian/Ubuntu apt repositories</a></li>
<li><a href="#download-the-latest-release-of-iredmail">Download the latest release of iRedMail</a></li> <li><a href="#download-the-latest-release-of-iredmail">Download the latest release of iRedMail</a></li>
</ul> </ul>
</li> </li>
@ -40,14 +40,20 @@ and configure them for you automatically. Otherwise it may override your
existing files/configurations althought it will backup files before modifing, existing files/configurations althought it will backup files before modifing,
and it may be not working as expected.</p> and it may be not working as expected.</p>
</blockquote> </blockquote>
<p>To install iRedMail on Debian Linux, you need:</p> <p>To install iRedMail on Debian or Ubuntu Linux, you need:</p>
<ul> <ul>
<li>A FRESH, working Debian Linux. Supported releases are listed on <li>A FRESH, working Debian/Ubuntu Linux. Supported releases are listed on
<a href="../download.html">Download</a> page.</li> <a href="../download.html">Download</a> page.</li>
<li>At least <code>1 GB</code> of memory is required for low traffic production server. <li>At least <code>1 GB</code> of memory is required for low traffic production server.
Spam/Virus scanning will take most system resource.</li> Spam/Virus scanning will take most system resource.</li>
</ul> </ul>
<p>Note: All binary packages will be installed from Debian official apt repositories.</p> <p>Notes:</p>
<ul>
<li>All binary packages will be installed from Debian/Ubuntu official apt
repositories.</li>
<li>If you choose Ubuntu Linux, it's recommended to use the latest Ubuntu LTS
(Long Term Support) release for production use.</li>
</ul>
<h2 id="preparations">Preparations</h2> <h2 id="preparations">Preparations</h2>
<h3 id="set-a-fully-qualified-domain-name-fqdn-hostname-on-your-server">Set a fully qualified domain name (FQDN) hostname on your server</h3> <h3 id="set-a-fully-qualified-domain-name-fqdn-hostname-on-your-server">Set a fully qualified domain name (FQDN) hostname on your server</h3>
<p>No matter your server is a testing machine or production server, it's strongly <p>No matter your server is a testing machine or production server, it's strongly
@ -57,7 +63,7 @@ recommended to set a fully qualified domain name (FQDN) hostname.</p>
mx.example.com mx.example.com
</code></pre> </code></pre>
<p>On Debian, hostname is set in two files: <code>/etc/hostname</code> and <code>/etc/hosts</code>.</p> <p>On Debian/Ubuntu Linux, hostname is set in two files: <code>/etc/hostname</code> and <code>/etc/hosts</code>.</p>
<ul> <ul>
<li><code>/etc/hostname</code>: short hostname, not FQDN.</li> <li><code>/etc/hostname</code>: short hostname, not FQDN.</li>
</ul> </ul>
@ -78,9 +84,9 @@ please reboot server to make it work.</p>
mx.example.com mx.example.com
</code></pre> </code></pre>
<h3 id="enable-default-official-debian-apt-repositories">Enable default official Debian apt repositories</h3> <h3 id="enable-default-official-debianubuntu-apt-repositories">Enable default official Debian/Ubuntu apt repositories</h3>
<ul> <ul>
<li>iRedMail needs official Debian apt repositories, please enable them in <li>iRedMail needs official Debian/Ubuntu apt repositories, please enable them in
<code>/etc/apt/sources.lists</code>.</li> <code>/etc/apt/sources.lists</code>.</li>
<li>Install package <code>bzip2</code> so that you can uncompress downloaded iRedMail package.</li> <li>Install package <code>bzip2</code> so that you can uncompress downloaded iRedMail package.</li>
</ul> </ul>
@ -107,11 +113,11 @@ mx.example.com
</code></pre> </code></pre>
<h2 id="start-iredmail-installer">Start iRedMail installer</h2> <h2 id="start-iredmail-installer">Start iRedMail installer</h2>
<p>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.</p>
<blockquote> <blockquote>
<p>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.</p> <p>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.</p>
</blockquote> </blockquote>
<p>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.</p>
<pre><code># cd /root/iRedMail-x.y.z/ <pre><code># cd /root/iRedMail-x.y.z/
# bash iRedMail.sh # bash iRedMail.sh
</code></pre> </code></pre>

250
html/install.iredmail.on.openbsd.html Normal file
View File

@ -0,0 +1,250 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Install iRedMail on OpenBSD</title>
<link href="./css/markdown.css" rel="stylesheet"></head>
</head>
<body>
<div id="navigation">
<a href="http://www.iredmail.org" target="_blank">iRedMail web site</a>
// <a href="./index.html">Document Index</a>
</div><h1 id="install-iredmail-on-openbsd">Install iRedMail on OpenBSD</h1>
<div class="toc">
<ul>
<li><a href="#install-iredmail-on-openbsd">Install iRedMail on OpenBSD</a><ul>
<li><a href="#system-requirements">System Requirements</a></li>
<li><a href="#preparations">Preparations</a><ul>
<li><a href="#set-a-fully-qualified-domain-name-fqdn-hostname-on-your-server">Set a fully qualified domain name (FQDN) hostname on your server</a></li>
<li><a href="#choose-a-nearest-mirror-site-for-installing-binary-packages">Choose a nearest mirror site for installing binary packages</a></li>
<li><a href="#download-the-latest-release-of-iredmail">Download the latest release of iRedMail</a></li>
</ul>
</li>
<li><a href="#start-iredmail-installer">Start iRedMail installer</a></li>
<li><a href="#screenshots-of-installation">Screenshots of installation:</a></li>
<li><a href="#important-things-you-must-know-after-installation">Important things you MUST know after installation</a></li>
<li><a href="#access-webmail-and-other-web-applications">Access webmail and other web applications</a></li>
<li><a href="#get-technical-support">Get technical support</a></li>
<li><a href="#notes-about-binary-packages-provided-by-iredmail-project">Notes about binary packages provided by iRedMail project</a></li>
</ul>
</li>
</ul>
</div>
<h2 id="system-requirements">System Requirements</h2>
<blockquote>
<p><strong>WARNING</strong>: iRedMail is designed to be deployed on a FRESH server system,
which means your server does <strong>NOT</strong> 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.</p>
</blockquote>
<p>To install iRedMail on OpenBSD, you need:</p>
<ul>
<li>A FRESH, working OpenBSD system. Supported releases are listed on
<a href="../download.html">Download</a> page.</li>
<li>At least <code>1 GB</code> of memory is required for low traffic production server.
Spam/Virus scanning will take most system resource.</li>
<li>
<p>Required OpenBSD installation file sets are (replace <code>[XX]</code> by the real
OpenBSD release number):</p>
<ul>
<li>base[XX].tgz</li>
<li>etc[XX].tgz</li>
<li>comp[XX].tgz</li>
<li>man[XX].tgz</li>
<li>xbase[XX].tgz</li>
</ul>
</li>
</ul>
<p>Notes:</p>
<ul>
<li>All binary packages will be installed with command <code>pkg_add -i</code>.</li>
<li>Apache chroot is disabled by default, required by iRedAdmin - the web-based
admin panel.</li>
<li>PF is enabled by default, with basic rules for ssh and mail services.</li>
<li>System built-in <a href="http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man8/spamd.8"><code>spamd(8)</code></a> is enabled by default for greylisting,
whitelisting, blacklisting.</li>
<li>Sendmail is disabled by default, replaced by Postfix.</li>
</ul>
<h2 id="preparations">Preparations</h2>
<h3 id="set-a-fully-qualified-domain-name-fqdn-hostname-on-your-server">Set a fully qualified domain name (FQDN) hostname on your server</h3>
<p>No matter your server is a testing machine or production server, it's strongly
recommended to set a fully qualified domain name (FQDN) hostname.</p>
<p>Enter command <code>hostname -f</code> to view the current hostname:</p>
<pre><code class="shell">$ hostname -f
mx.example.com
</code></pre>
<p>On OpenBSD, hostname is set in two files: <code>/etc/myname</code> and <code>/etc/hosts</code>.</p>
<ul>
<li><code>/etc/myname</code>: FQDN.</li>
</ul>
<pre><code>mx.example.com
</code></pre>
<ul>
<li><code>/etc/hosts</code>: static table lookup for hostnames. <strong>Warning</strong>: Please list the
FQDN hostname as first item.</li>
</ul>
<pre><code># Part of file: /etc/hosts
127.0.0.1 mx.example.com mx localhost localhost.localdomain
</code></pre>
<p>Verify the FQDN hostname. If it wasn't changed after updating above two files,
please reboot server to make it work.</p>
<pre><code>$ hostname -f
mx.example.com
</code></pre>
<h3 id="choose-a-nearest-mirror-site-for-installing-binary-packages">Choose a nearest mirror site for installing binary packages</h3>
<p>iRedMail will install all required binary packages with command <code>pkg_add -i</code>,
it will check whether you have mirror site defined in <code>PKG_PATH</code> environment
variable, if defined, <code>pkg_add</code> will install packages from defined mirror site.</p>
<p>It's recommended to install packages from a mirror site, to reduce server
load on OpenBSD primary servers. Also, installing package from a nearest
mirror site will speed up package installation. You can find mirror list
near you on OpenBSD web site:
<a href="http://www.openbsd.org/ftp.html#http">Getting OpenBSD</a>.</p>
<p>Now login to the OpenBSD server as root user, set variable <code>PKG_PATH</code> in file
<code>/root/.profile</code> like below (use your nearest mirror site instead):</p>
<pre><code>export PKG_PATH=&quot;http://ftp.jaist.ac.jp/pub/OpenBSD/`uname -r`/packages/`machine -a`/&quot;
</code></pre>
<p>Install Bash shell, it's required by iRedMail.</p>
<pre><code># . /root/.profile # &lt;- This steps is required, used to set PKG_PATH without re-login.
# pkg_add bash
</code></pre>
<h3 id="download-the-latest-release-of-iredmail">Download the latest release of iRedMail</h3>
<ul>
<li>
<p>Visit <a href="../download.html">Download page</a> to get the
latest stable release of iRedMail.</p>
</li>
<li>
<p>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 <code>/root/iRedMail-x.y.z.tar.bz2</code> (replace x.y.z by the real version number).</p>
</li>
<li>
<p>Uncompress iRedMail tarball:</p>
</li>
</ul>
<pre><code># cd /root/
# tar xjf iRedMail-x.y.z.tar.bz2
</code></pre>
<h2 id="start-iredmail-installer">Start iRedMail installer</h2>
<blockquote>
<p>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.</p>
</blockquote>
<p>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.</p>
<pre><code># cd /root/iRedMail-x.y.z/
# bash iRedMail.sh
</code></pre>
<h2 id="screenshots-of-installation">Screenshots of installation:</h2>
<ul>
<li>Welcome and thanks for your use</li>
</ul>
<p><img alt="" src="../images/installation/iredmail/welcome.png" /></p>
<ul>
<li>Specify location to store all mailboxes. Default is <code>/var/vmail/</code>.</li>
</ul>
<p><img alt="" src="../images/installation/iredmail/location_to_store_mailboxes.png" /></p>
<ul>
<li>Choose backend used to store mail accounts. You can manage mail accounts
with iRedAdmin, our web-based iRedMail admin panel.</li>
</ul>
<p><strong>IMPORTANT NOTE</strong>: 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.</p>
<p><img alt="" src="../images/installation/iredmail/backend.png" /></p>
<ul>
<li>If you choose to store mail accounts in OpenLDAP, iRedMail installer will
ask you two questions about OpenLDAP.</li>
</ul>
<p>LDAP suffix.</p>
<p><img alt="" src="../images/installation/iredmail/ldap_suffix.png" /></p>
<p>Password of LDAP root dn.</p>
<p><img alt="" src="../images/installation/iredmail/pw_of_ldap_root_dn.png" /></p>
<ul>
<li>Set password of MySQL or PostgreSQL admin user.</li>
</ul>
<p><strong>NOTE</strong>: MySQL is used to store data of other applications (e.g. Roundcube
webmail, Cluebringer, Amavisd-new) if you choose OpenLDAP or MySQL as backend.</p>
<p><img alt="" src="../images/installation/iredmail/pw_of_mysql_root_user.png" /></p>
<ul>
<li>Add your first mail domain name</li>
</ul>
<p><img alt="" src="../images/installation/iredmail/first_mail_domain.png" /></p>
<ul>
<li>Set password of admin account of your first mail domain.</li>
</ul>
<p><strong>Note</strong>: 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.</p>
<p><img alt="" src="../images/installation/iredmail/pw_of_domain_admin.png" /></p>
<ul>
<li>Choose optional components</li>
</ul>
<p><img alt="" src="../images/installation/iredmail/optional_components.png" /></p>
<p>After answered above questions, iRedMail installer will ask your confirm to
start installation. It will install and configure required packages
automatically. Type <code>y</code> or <code>Y</code> and press <code>Enter</code> to start.</p>
<pre><code>Configuration completed.
*************************************************************************
**************************** WARNING ***********************************
*************************************************************************
* *
* Please do remember to *REMOVE* configuration file after installation *
* completed successfully. *
* *
* * /root/iRedMail-x.y.z/config
* *
*************************************************************************
&lt;&lt;&lt; iRedMail &gt;&gt;&gt; Continue? [Y|n] # &lt;- Type 'Y' or 'y' here, and press 'Enter' to continue
</code></pre>
<h2 id="important-things-you-must-know-after-installation">Important things you <strong>MUST</strong> know after installation</h2>
<ul>
<li>
<p>Read file <code>/root/iRedMail-x.y.z/iRedMail.tips</code> first, it contains:</p>
<ul>
<li>URLs, usernames and passwords of web-based applications</li>
<li>Location of mail serve related software configuration files</li>
<li>Some other important and sensitive information</li>
</ul>
</li>
<li>
<p><a href="./setup_dns.html">Setup DNS records for your mail server</a></p>
</li>
</ul>
<h2 id="access-webmail-and-other-web-applications">Access webmail and other web applications</h2>
<p>After installation successfully completed, you can access web-based programs
if you choose to install them. Replace <code>your_server</code> below by your real server
hostname or IP address.</p>
<ul>
<li><strong>Roundcube webmail</strong>: <a href="https://your_server/mail/">https://your_server/mail/</a></li>
<li><strong>Web admin panel (iRedAdmin)</strong>: <a href="httpS://your_server/iredadmin/">httpS://your_server/iredadmin/</a></li>
<li><strong>phpLDAPadmin</strong> (available if you choose LDAP backend): <a href="httpS://your_server/phpldapadmin/">httpS://your_server/phpldapadmin/</a></li>
<li><strong>Awstats</strong>: <a href="httpS://your_server/awstats/awstats.pl?config=web">httpS://your_server/awstats/awstats.pl?config=web</a> (or ?config=smtp)</li>
</ul>
<h2 id="get-technical-support">Get technical support</h2>
<p>Please post all issues, feedbacks, feature requests, suggestions in our <a href="http://www.iredmail.org/forum/">online
support forum</a>, it's more responsible than you
expected.</p>
<h2 id="notes-about-binary-packages-provided-by-iredmail-project">Notes about binary packages provided by iRedMail project</h2>
<p>Most binary packages in iRedMail yum repository comes from below repositories,
packages with <code>-ired</code> flag were packed by iRedMail project.</p>
<ul>
<li><a href="http://packages.sw.be/">Dag Wieers</a></li>
<li><a href="http://download.fedora.redhat.com/pub/epel/">EPEL</a></li>
<li><a href="http://atrpms.net/">ATrpms</a></li>
</ul><br /><p style="text-align: center;">If you found something wrong
in this document, please do
<a href="http://www.iredmail.org/contact.html">contact us</a> to fix it.</p><p style="text-align: center; color: grey;">&copy&copy Creative Commons</p></body></html>

4
html/install.iredmail.on.rhel.html
View File

@ -120,11 +120,11 @@ value in its config file <code>/etc/selinux/config</code>.</p>
</code></pre> </code></pre>
<h2 id="start-iredmail-installer">Start iRedMail installer</h2> <h2 id="start-iredmail-installer">Start iRedMail installer</h2>
<p>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.</p>
<blockquote> <blockquote>
<p>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.</p> <p>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.</p>
</blockquote> </blockquote>
<p>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.</p>
<pre><code># cd /root/iRedMail-x.y.z/ <pre><code># cd /root/iRedMail-x.y.z/
# bash iRedMail.sh # bash iRedMail.sh
</code></pre> </code></pre>

23
installation/install.iredmail.on.debian.md → installation/install.iredmail.on.debian.ubuntu.md
View File

@ -1,4 +1,4 @@
# Install iRedMail on Debian Linux # Install iRedMail on Debian or Ubuntu Linux
[TOC] [TOC]
@ -11,14 +11,19 @@
> existing files/configurations althought it will backup files before modifing, > existing files/configurations althought it will backup files before modifing,
> and it may be not working as expected. > and it may be not working as expected.
To install iRedMail on Debian Linux, you need: To install iRedMail on Debian or Ubuntu Linux, you need:
* A FRESH, working Debian Linux. Supported releases are listed on * A FRESH, working Debian/Ubuntu Linux. Supported releases are listed on
[Download](../download.html) page. [Download](../download.html) page.
* At least `1 GB` of memory is required for low traffic production server. * At least `1 GB` of memory is required for low traffic production server.
Spam/Virus scanning will take most system resource. Spam/Virus scanning will take most system resource.
Note: All binary packages will be installed from Debian official apt repositories. Notes:
* All binary packages will be installed from Debian/Ubuntu official apt
repositories.
* If you choose Ubuntu Linux, it's recommended to use the latest Ubuntu LTS
(Long Term Support) release for production use.
## Preparations ## Preparations
@ -34,7 +39,7 @@ $ hostname -f
mx.example.com mx.example.com
``` ```
On Debian, hostname is set in two files: `/etc/hostname` and `/etc/hosts`. On Debian/Ubuntu Linux, hostname is set in two files: `/etc/hostname` and `/etc/hosts`.
* `/etc/hostname`: short hostname, not FQDN. * `/etc/hostname`: short hostname, not FQDN.
@ -58,9 +63,9 @@ $ hostname -f
mx.example.com mx.example.com
``` ```
### Enable default official Debian apt repositories ### Enable default official Debian/Ubuntu apt repositories
* iRedMail needs official Debian apt repositories, please enable them in * iRedMail needs official Debian/Ubuntu apt repositories, please enable them in
`/etc/apt/sources.lists`. `/etc/apt/sources.lists`.
* Install package `bzip2` so that you can uncompress downloaded iRedMail package. * Install package `bzip2` so that you can uncompress downloaded iRedMail package.
@ -86,11 +91,11 @@ mx.example.com
## Start iRedMail installer ## Start iRedMail installer
> 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.
It's now ready to start iRedMail installer, it will ask you several simple 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. 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/ # cd /root/iRedMail-x.y.z/
# bash iRedMail.sh # bash iRedMail.sh

240
installation/install.iredmail.on.openbsd.md Normal file
View File

@ -0,0 +1,240 @@
# Install iRedMail on OpenBSD
[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 OpenBSD, you need:
* A FRESH, working OpenBSD 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.
* Required OpenBSD installation file sets are (replace `[XX]` by the real
OpenBSD release number):
* base[XX].tgz
* etc[XX].tgz
* comp[XX].tgz
* man[XX].tgz
* xbase[XX].tgz
Notes:
* All binary packages will be installed with command `pkg_add -i`.
* Apache chroot is disabled by default, required by iRedAdmin - the web-based
admin panel.
* PF is enabled by default, with basic rules for ssh and mail services.
* System built-in [`spamd(8)`](http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man8/spamd.8) is enabled by default for greylisting,
whitelisting, blacklisting.
* Sendmail is disabled by default, replaced by Postfix.
## 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 OpenBSD, hostname is set in two files: `/etc/myname` and `/etc/hosts`.
* `/etc/myname`: FQDN.
```
mx.example.com
```
* `/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
```
### Choose a nearest mirror site for installing binary packages
iRedMail will install all required binary packages with command `pkg_add -i`,
it will check whether you have mirror site defined in `PKG_PATH` environment
variable, if defined, `pkg_add` will install packages from defined mirror site.
It's recommended to install packages from a mirror site, to reduce server
load on OpenBSD primary servers. Also, installing package from a nearest
mirror site will speed up package installation. You can find mirror list
near you on OpenBSD web site:
[Getting OpenBSD](http://www.openbsd.org/ftp.html#http).
Now login to the OpenBSD server as root user, set variable `PKG_PATH` in file
`/root/.profile` like below (use your nearest mirror site instead):
```
export PKG_PATH="http://ftp.jaist.ac.jp/pub/OpenBSD/`uname -r`/packages/`machine -a`/"
```
Install Bash shell, it's required by iRedMail.
```
# . /root/.profile # <- This steps is required, used to set PKG_PATH without re-login.
# pkg_add bash
```
### 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
> 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.
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.
```
# 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/)

4
installation/install.iredmail.on.rhel.md
View File

@ -101,11 +101,11 @@ Now disable it immediately without rebooting your server.
## Start iRedMail installer ## Start iRedMail installer
> 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.
It's now ready to start iRedMail installer, it will ask you several simple 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. 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/ # cd /root/iRedMail-x.y.z/
# bash iRedMail.sh # bash iRedMail.sh