iredmail-doc/html/install.iredmail.on.openbsd...

262 lines
13 KiB
HTML

<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>
<li><a href="./configure.thunderbird.html">Configure Thunderbird as mail client (POP3/IMAP, SMTP and global ldap address book)</a></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;">This tutorial is published under a <a href="http://creativecommons.org/licenses/by-nd/3.0/us/" target="_blank">CC BY-ND 3.0</a> license.<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-3293801-14");
pageTracker._trackPageview();
} catch(err) {}
</script>
</body></html>