2016-05-19 06:51:20 -05:00
<!DOCTYPE html>
2014-10-11 00:25:17 -05:00
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2014-10-11 00:50:41 -05:00
< title > Install iRedMail on OpenBSD< / title >
2015-07-31 23:14:52 -05:00
< link rel = "stylesheet" type = "text/css" href = "./css/markdown.css" / >
2014-10-11 00:25:17 -05:00
< / head >
< body >
< div id = "navigation" >
2017-11-16 21:48:44 -06:00
< a href = "https://www.iredmail.org" target = "_blank" >
2016-04-19 12:48:51 -05:00
< img alt = "iRedMail web site"
src="./images/logo-iredmail.png"
style="vertical-align: middle; height: 30px;"
/>
< span > iRedMail< / span >
< / a >
2016-02-29 02:15:19 -06:00
// < a href = "./index.html" > Document Index< / a > < / div > < h1 id = "install-iredmail-on-openbsd" > Install iRedMail on OpenBSD< / h1 >
2014-10-11 00:25:17 -05:00
< div class = "toc" >
< ul >
2014-10-11 00:50:41 -05:00
< li > < a href = "#install-iredmail-on-openbsd" > Install iRedMail on OpenBSD< / a > < ul >
2014-10-11 00:25:17 -05:00
< 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 >
2014-10-11 00:50:41 -05:00
< li > < a href = "#choose-a-nearest-mirror-site-for-installing-binary-packages" > Choose a nearest mirror site for installing binary packages< / a > < / li >
2014-10-11 00:25:17 -05:00
< 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 >
2018-02-07 00:50:30 -06:00
< li > < a href = "#screenshots-of-installation" > Screenshots of installation< / a > < / li >
2014-10-11 00:25:17 -05:00
< 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 >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "system-requirements" > System Requirements< / h2 >
2016-02-29 07:23:05 -06:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
2016-02-29 07:18:38 -06:00
< p > iRedMail is designed to be deployed on a < strong > FRESH< / strong > server system, which
means your server does < strong > NOT< / strong > have mail related components installed,
2014-10-11 00:25:17 -05:00
e.g. MySQL, OpenLDAP, Postfix, Dovecot, Amavisd, etc. iRedMail will install
and configure them for you automatically. Otherwise it may override your
2016-02-29 07:18:38 -06:00
existing files/configurations althought it will backup files before
modifying, and it may not be working as expected.< / p >
< / div >
2015-01-04 10:08:34 -06:00
< p > To install iRedMail on OpenBSD, you need:< / p >
2014-10-11 00:25:17 -05:00
< ul >
2014-11-04 17:43:25 -06:00
< li > A < strong > FRESH< / strong > , working OpenBSD system. Supported releases are listed on
2017-11-16 21:48:44 -06:00
< a href = "https://www.iredmail.org/download.html" > Download< / a > page.< / li >
2015-06-28 09:41:48 -05:00
< li > < code > 2 GB< / code > of memory is recommended for a low traffic production server.
2014-10-11 00:25:17 -05:00
Spam/Virus scanning will take most system resource.< / li >
2014-10-11 00:50:41 -05:00
< 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 >
2017-02-09 07:27:32 -06:00
< li >
< p > Make sure 3 UID/GID are not used by other user/group: 2000, 2001, 2002.< / p >
< / li >
2014-10-11 00:50:41 -05:00
< / ul >
2016-02-29 07:18:38 -06:00
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
2014-10-11 00:50:41 -05:00
< ul >
2018-02-07 00:44:23 -06:00
< li > All binary packages will be installed with command < code > pkg_add -i< / code > .< / li >
< li > Nginx is used as web server.< / li >
2014-10-11 00:50:41 -05:00
< li > PF is enabled by default, with basic rules for ssh and mail services.< / li >
2015-05-05 21:31:45 -05:00
< li > OpenSMTPd are disabled by default, replaced by Postfix.< / li >
2014-10-11 00:25:17 -05:00
< / ul >
2016-02-29 07:18:38 -06:00
< / div >
2014-10-11 00:25:17 -05:00
< 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 >
2015-05-01 22:02:34 -05:00
< p > Enter command < code > hostname< / code > to view the current hostname:< / p >
< pre > < code class = "shell" > $ hostname
2014-10-11 00:25:17 -05:00
mx.example.com
< / code > < / pre >
2014-10-11 00:50:41 -05:00
< p > On OpenBSD, hostname is set in two files: < code > /etc/myname< / code > and < code > /etc/hosts< / code > .< / p >
2014-10-11 00:25:17 -05:00
< ul >
2014-10-11 00:50:41 -05:00
< li > < code > /etc/myname< / code > : FQDN.< / li >
2014-10-11 00:25:17 -05:00
< / ul >
2014-10-11 00:50:41 -05:00
< pre > < code > mx.example.com
2014-10-11 00:25:17 -05:00
< / 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 >
2015-05-01 22:02:34 -05:00
< pre > < code > $ hostname
2014-10-11 00:25:17 -05:00
mx.example.com
< / code > < / pre >
2014-10-11 00:50:41 -05:00
< 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=" http://ftp.jaist.ac.jp/pub/OpenBSD/`uname -r`/packages/`machine -a`/"
< / code > < / pre >
< p > Install Bash shell, it's required by iRedMail.< / p >
< pre > < code > # . /root/.profile # < - This steps is required, used to set PKG_PATH without re-login.
2016-05-24 22:21:39 -05:00
# pkg_add bash bzip2
2014-10-11 00:25:17 -05:00
< / code > < / pre >
< h3 id = "download-the-latest-release-of-iredmail" > Download the latest release of iRedMail< / h3 >
< ul >
< li >
2017-11-16 21:48:44 -06:00
< p > Visit < a href = "https://www.iredmail.org/download.html" > Download page< / a > to get the
2014-10-11 00:25:17 -05:00
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 >
2014-10-11 00:50:41 -05:00
< p > It's now ready to start iRedMail installer, it will ask you several simple
2015-11-26 02:03:27 -06:00
questions, that's all required to setup a full-featured mail server.< / p >
2014-10-11 00:25:17 -05:00
< pre > < code > # cd /root/iRedMail-x.y.z/
# bash iRedMail.sh
< / code > < / pre >
2016-02-29 07:18:38 -06:00
< div class = "admonition note" >
< p class = "admonition-title" > To Chinese users< / p >
< p > Our domain name < code > iredmail.org< / code > is blocked in mainland
China since Jun 04, 2011, please run command below to finish the installation:< / p >
2017-11-10 02:38:00 -06:00
< p > < code > IREDMAIL_MIRROR='https://dl.iredmail.org' bash iRedMail.sh< / code > < / p >
2016-02-29 07:18:38 -06:00
< / div >
2018-02-07 00:50:30 -06:00
< h2 id = "screenshots-of-installation" > Screenshots of installation< / h2 >
2014-10-11 00:25:17 -05:00
< ul >
< li > Welcome and thanks for your use< / li >
< / ul >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/welcome.png" width = "700px" / > < / p >
2014-10-11 00:25:17 -05:00
< ul >
< li > Specify location to store all mailboxes. Default is < code > /var/vmail/< / code > .< / li >
< / ul >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/mail_storage.png" width = "700px" / > < / p >
2014-10-11 00:25:17 -05:00
< ul >
< li > Choose backend used to store mail accounts. You can manage mail accounts
with iRedAdmin, our web-based iRedMail admin panel.< / li >
< / ul >
2016-02-29 07:18:38 -06:00
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > There's no big difference between available backends, so
2014-10-11 00:25:17 -05:00
it's strongly recommended to choose the one you're familiar with for easier
management and maintenance after installation.< / p >
2016-02-29 07:18:38 -06:00
< / div >
2018-02-07 00:50:30 -06:00
< p > < img alt = "" src = "./images/installation/backends_openbsd.png" width = "700px" / > < / p >
2014-10-11 00:25:17 -05:00
< ul >
< li > If you choose to store mail accounts in OpenLDAP, iRedMail installer will
2016-04-19 12:48:51 -05:00
ask to set the LDAP suffix.< / li >
2014-10-11 00:25:17 -05:00
< / ul >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/ldap_suffix.png" width = "700px" / > < / p >
2016-02-29 07:18:38 -06:00
< div class = "admonition note" >
< p class = "admonition-title" > To MySQL/MariaDB/PostgreSQL users< / p >
2016-01-16 09:10:14 -06:00
< p > If you choose to store mail accounts in MySQL/MariaDB/PostgreSQL, iRedMail
2016-02-29 07:18:38 -06:00
installer will generate a random, strong password for you. You can find it
in file < code > iRedMail.tips< / code > .< / p >
< / div >
< ul >
< li > Add your first mail domain name< / li >
2014-10-11 00:25:17 -05:00
< / ul >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/first_domain.png" width = "700px" / > < / p >
2014-10-11 00:25:17 -05:00
< 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 >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/admin_pw.png" width = "700px" / > < / p >
2014-10-11 00:25:17 -05:00
< ul >
< li > Choose optional components< / li >
< / ul >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/optional_components.png" width = "700px" / > < / p >
< p > After answered above questions, iRedMail installer will ask you to review and
confirm to start installation. It will install and configure required packages
2014-10-11 00:25:17 -05:00
automatically. Type < code > y< / code > or < code > Y< / code > and press < code > Enter< / code > to start.< / p >
2016-05-15 21:18:14 -05:00
< p > < img alt = "" src = "./images/installation/review.png" width = "700px" / > < / p >
2014-10-11 00:25:17 -05:00
< h2 id = "important-things-you-must-know-after-installation" > Important things you < strong > MUST< / strong > know after installation< / h2 >
2016-09-15 02:49:23 -05:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
2015-09-23 20:42:57 -05:00
< p > The weakest part of a mail server is user's weak password. Spammers don't
2015-09-23 20:44:20 -05:00
want to hack your server, they just want to send spam from your server.
2015-09-23 20:42:57 -05:00
Please < strong > ALWAYS ALWAYS ALWAYS< / strong > force users to use a strong password.< / p >
2016-09-15 02:49:23 -05:00
< / div >
2014-10-11 00:25:17 -05:00
< 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 >
2015-05-02 11:25:55 -05:00
< li > Location of mail service related software configuration files. You can
also check this tutorial instead:
2016-02-10 06:05:52 -06:00
< a href = "./file.locations.html" > Locations of configuration and log files of major components< / a > .< / li >
2014-10-11 00:25:17 -05:00
< li > Some other important and sensitive information< / li >
< / ul >
< / li >
< li >
2014-11-02 17:59:04 -06:00
< p > < a href = "./setup.dns.html" > Setup DNS records for your mail server< / a > < / p >
2014-10-11 00:25:17 -05:00
< / li >
2015-12-10 06:51:58 -06:00
< li > < a href = "./index.html#configure-mail-client-applications" > How to configure your mail clients< / a > < / li >
2016-12-17 09:39:20 -06:00
< li > < a href = "./file.locations.html" > Locations of configuration and log files of major components< / a > < / li >
2016-02-25 03:17:57 -06:00
< li > It's highly recommended to get a SSL cert to avoid annonying warning
2014-12-26 00:30:33 -06:00
message in web browser or mail clients when accessing mailbox via
2016-02-25 03:17:57 -06:00
HTTPS/IMAPS/POP3/SMTPS. < a href = "https://letsencrypt.org" > Let's Encrypt offers < strong > FREE< / strong > SSL certificate< / a > .
2015-09-29 01:27:10 -05:00
We have a document for you to
2016-04-19 12:48:51 -05:00
< a href = "./use.a.bought.ssl.certificate.html" > use a SSL certificate< / a > .< / li >
2015-09-29 01:27:10 -05:00
< li > If you need to bulk create mail users, check our document for
< a href = "./ldap.bulk.create.mail.users.html" > OpenLDAP< / a > and
< a href = "./sql.bulk.create.mail.users.html" > MySQL/MariaDB/PostgreSQL< / a > .< / li >
2015-07-07 08:09:17 -05:00
< li > If you're running a busy mail server, we have < a href = "./performance.tuning.html" > some suggestions for better
performance< / a > .< / li >
2014-10-11 00:25:17 -05:00
< / 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 >
2015-12-10 06:51:58 -06:00
< li > < strong > SOGo Groupware< / strong > : < a href = "https://your_server/SOGo" > https://your_server/SOGo< / a > < / li >
2014-10-11 00:25:17 -05:00
< li > < strong > Web admin panel (iRedAdmin)< / strong > : < a href = "httpS://your_server/iredadmin/" > httpS://your_server/iredadmin/< / a > < / li >
2016-10-13 09:24:50 -05:00
< li > < strong > Awstats< / strong > : < a href = "httpS://your_server/awstats/awstats.pl?config=web" > httpS://your_server/awstats/awstats.pl?config=web< / a > (or
< code > ?config=smtp< / code > for SMTP traffic log)< / li >
2014-10-11 00:25:17 -05:00
< / ul >
< h2 id = "get-technical-support" > Get technical support< / h2 >
2016-03-22 11:17:36 -06:00
< ul >
< li > You are welcome to post issues, feedbacks, feature requests, suggestions in
2017-11-16 21:48:44 -06:00
our < a href = "https://forum.iredmail.org/" > online support forum< / a > , it's more
2016-03-22 11:17:36 -06:00
responsible than you expected.< / li >
< li > We offer paid professional support service too, check our web site for more
2017-11-16 21:48:44 -06:00
details: < a href = "https://www.iredmail.org/support.html" > Get Professional Support from iRedMail Team< / a > .< / li >
2016-05-19 06:51:20 -05:00
< / ul > < div class = "footer" >
2017-11-16 21:48:44 -06:00
< p style = "text-align: center; color: grey;" > All documents are available in < a href = "https://bitbucket.org/zhb/iredmail-docs/src" > BitBucket repository< / a > , and published under < a href = "http://creativecommons.org/licenses/by-nd/3.0/us/" target = "_blank" > Creative Commons< / a > license. You can < a href = "https://bitbucket.org/zhb/iredmail-docs/get/tip.tar.bz2" > download the latest version< / a > for offline reading. If you found something wrong, please do < a href = "https://www.iredmail.org/contact.html" > contact us< / a > to fix it.< / p >
2016-05-19 06:51:20 -05:00
< / div >
2017-11-05 02:33:58 -06:00
<!-- Global site tag (gtag.js) - Google Analytics -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=UA-3293801-21" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
2015-02-05 07:02:53 -06:00
2017-11-05 02:33:58 -06:00
gtag('config', 'UA-3293801-21');
2014-10-13 19:28:43 -05:00
< / script >
< / body > < / html >
