2014-10-11 00:50:41 -05:00
# Install iRedMail on OpenBSD
2014-10-11 00:25:17 -05:00
[TOC]
2018-12-14 01:06:22 -06:00
!!! attention
It's recommended to use the new __iRedMail Easy__ deployment and support
platform to deploy and keep your mail server up to date, technical support
is available through the ticket system.
Read more: [iRedMail Easy - Meet our new deployment and support platform ](./iredmail-easy.getting.start.html )
2014-10-11 00:25:17 -05:00
## System Requirements
2016-02-29 07:23:05 -06:00
!!! warning
2016-02-29 07:18:38 -06:00
2019-04-03 23:21:37 -06:00
* 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
2020-05-05 11:11:29 -05:00
existing files/configurations although it will backup files before
2019-04-03 23:21:37 -06:00
modifying, and it may not be working as expected.
2020-06-12 00:14:42 -05:00
* Many ISPs block port 25 by default, it's used for communication between
mail servers, it must be open, otherwise your server may be not able to
receive or / and send emails. Please contact your ISP to make sure it's
not blocked, or ask them to unblock.
- Amazon AWS EC2. Request to [remove the throttle on port 25 ](https://aws.amazon.com/premiumsupport/knowledge-center/ec2-port-25-throttle/ ).
- Google Cloud Platform.
- Microsoft Azure.
- Linode. Explained in the [blog post ](https://www.linode.com/blog/linode/a-new-policy-to-help-fight-spam/ ),
you can open a support ticket to request the Linode team to open it.
2020-06-18 10:22:08 -05:00
- DigitalOcean. According to [a post in their community ](https://www.digitalocean.com/community/questions/port-25-465-is-blocked-how-can-i-enable-it ), __SEEMS__ impossible to unblock port 25, that means you can __NOT__ run mail server on DigitalOcean VPS.
2015-01-04 10:08:34 -06:00
2014-10-11 00:50:41 -05:00
To install iRedMail on OpenBSD, you need:
2014-10-11 00:25:17 -05:00
2014-11-04 17:43:25 -06:00
* A __FRESH__ , working OpenBSD system. Supported releases are listed on
2017-11-16 21:48:44 -06:00
[Download ](https://www.iredmail.org/download.html ) page.
2019-06-12 00:34:35 -05:00
* At least `2 GB` memory is required for a low traffic production mail server, but
`4 GB` is strongly recommended to prevent ClamAV eating too much memory for big virus
signature database.
2014-10-11 00:50:41 -05:00
* Required OpenBSD installation file sets are (replace `[XX]` by the real
OpenBSD release number):
2014-10-11 00:25:17 -05:00
2014-10-11 00:50:41 -05:00
* base[XX].tgz
* etc[XX].tgz
* comp[XX].tgz
* man[XX].tgz
* xbase[XX].tgz
2017-02-09 07:27:32 -06:00
* Make sure 3 UID/GID are not used by other user/group: 2000, 2001, 2002.
2016-02-29 07:18:38 -06:00
!!! note
2014-10-11 00:50:41 -05:00
2018-02-07 00:44:23 -06:00
* All binary packages will be installed with command `pkg_add -i` .
2016-02-29 07:18:38 -06:00
* Nginx is used as web server.
* PF is enabled by default, with basic rules for ssh and mail services.
* OpenSMTPd are disabled by default, replaced by Postfix.
2014-10-11 00:25:17 -05:00
## 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.
2015-05-01 22:02:34 -05:00
Enter command `hostname` to view the current hostname:
2014-10-11 00:25:17 -05:00
```shell
2015-05-01 22:02:34 -05:00
$ hostname
2014-10-11 00:25:17 -05:00
mx.example.com
```
2014-10-11 00:50:41 -05:00
On OpenBSD, hostname is set in two files: `/etc/myname` and `/etc/hosts` .
2014-10-11 00:25:17 -05:00
2014-10-11 00:50:41 -05:00
* `/etc/myname` : FQDN.
2014-10-11 00:25:17 -05:00
```
2014-10-11 00:50:41 -05:00
mx.example.com
2014-10-11 00:25:17 -05:00
```
* `/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.
```
2015-05-01 22:02:34 -05:00
$ hostname
2014-10-11 00:25:17 -05:00
mx.example.com
```
2014-10-11 00:50:41 -05:00
### Choose a nearest mirror site for installing binary packages
2018-02-07 04:22:25 -06:00
iRedMail will install all required binary packages with command `pkg_add -i`
from mirror site defined in file `/etc/installurl` (FYI:
[installurl(5) ](http://man.openbsd.org/installurl.5 )), If no mirror defined,
iRedMail will use the [fastly CDN ](https://fastly.cdn.openbsd.org/pub/OpenBSD/ )
for package installation.
2014-10-11 00:50:41 -05:00
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 ).
2018-02-07 04:22:25 -06:00
### Install required packages
2014-10-11 00:50:41 -05:00
2019-12-08 19:37:20 -06:00
iRedMail is wrote in Bash shell scripting language, so bash shell interpreter
is required, install it first:
2014-10-11 00:25:17 -05:00
```
2019-12-08 19:37:20 -06:00
pkg_add bash
2014-10-11 00:25:17 -05:00
```
### Download the latest release of iRedMail
2017-11-16 21:48:44 -06:00
* Visit [Download page ](https://www.iredmail.org/download.html ) to get the
2014-10-11 00:25:17 -05:00
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
2019-12-08 19:37:20 -06:00
it to `/root/iRedMail-x.y.z.tar.gz` (replace x.y.z by the real version number).
2014-10-11 00:25:17 -05:00
* Uncompress iRedMail tarball:
```
# cd /root/
2019-12-08 19:37:20 -06:00
# tar zxf iRedMail-x.y.z.tar.gz
2014-10-11 00:25:17 -05:00
```
## Start iRedMail installer
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.
2014-10-11 00:25:17 -05:00
```
# cd /root/iRedMail-x.y.z/
# bash iRedMail.sh
```
2018-02-07 00:50:30 -06:00
## Screenshots of installation
2014-10-11 00:25:17 -05:00
* Welcome and thanks for your use
2016-05-15 21:18:14 -05:00
![](./images/installation/welcome.png){: width="700px" }
2014-10-11 00:25:17 -05:00
* Specify location to store all mailboxes. Default is `/var/vmail/` .
2016-05-15 21:18:14 -05:00
![](./images/installation/mail_storage.png){: width="700px" }
2014-10-11 00:25:17 -05:00
* Choose backend used to store mail accounts. You can manage mail accounts
with iRedAdmin, our web-based iRedMail admin panel.
2016-02-29 07:18:38 -06:00
!!! 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.
2014-10-11 00:25:17 -05:00
2018-02-07 00:50:30 -06:00
![](./images/installation/backends_openbsd.png){: width="700px" }
2014-10-11 00:25:17 -05:00
* 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.
2014-10-11 00:25:17 -05:00
2016-05-15 21:18:14 -05:00
![](./images/installation/ldap_suffix.png){: width="700px" }
2014-10-11 00:25:17 -05:00
2016-02-29 07:18:38 -06:00
!!! note "To MySQL/MariaDB/PostgreSQL users"
If you choose to store mail accounts in MySQL/MariaDB/PostgreSQL, iRedMail
installer will generate a random, strong password for you. You can find it
in file `iRedMail.tips` .
2014-10-11 00:25:17 -05:00
* Add your first mail domain name
2016-05-15 21:18:14 -05:00
![](./images/installation/first_domain.png){: width="700px" }
2014-10-11 00:25:17 -05:00
* 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.
2016-05-15 21:18:14 -05:00
![](./images/installation/admin_pw.png){: width="700px" }
2014-10-11 00:25:17 -05:00
* Choose optional components
2016-05-15 21:18:14 -05:00
![](./images/installation/optional_components.png){: width="700px" }
2014-10-11 00:25:17 -05:00
2016-05-15 21:18:14 -05:00
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 `y` or `Y` and press `Enter` to start.
2016-05-15 21:18:14 -05:00
![](./images/installation/review.png){: width="700px" }
2014-10-11 00:25:17 -05:00
## Important things you __MUST__ know after installation
2016-09-15 02:49:23 -05:00
!!! warning
The weakest part of a mail server is user's weak password. Spammers don't
want to hack your server, they just want to send spam from your server.
Please __ALWAYS ALWAYS ALWAYS__ force users to use a strong password.
2015-09-23 20:42:57 -05:00
2014-10-11 00:25:17 -05:00
* Read file `/root/iRedMail-x.y.z/iRedMail.tips` first, it contains:
* URLs, usernames and passwords of web-based applications
2015-05-02 11:20:57 -05:00
* Location of mail service related software configuration files. You can
also check this tutorial instead:
2016-02-10 06:05:52 -06:00
[Locations of configuration and log files of major components ](./file.locations.html ).
2014-10-11 00:25:17 -05:00
* Some other important and sensitive information
2014-11-02 17:59:04 -06:00
* [Setup DNS records for your mail server ](./setup.dns.html )
2014-12-26 00:30:33 -06:00
* [How to configure your mail clients ](./index.html#configure-mail-client-applications )
2016-12-17 09:39:20 -06:00
* [Locations of configuration and log files of major components ](./file.locations.html )
2016-02-25 03:17:57 -06:00
* 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. [Let's Encrypt offers __FREE__ SSL certificate ](https://letsencrypt.org ).
2015-09-29 01:27:10 -05:00
We have a document for you to
2016-04-19 12:48:51 -05:00
[use a SSL certificate ](./use.a.bought.ssl.certificate.html ).
2015-09-29 01:27:10 -05:00
* If you need to bulk create mail users, check our document for
[OpenLDAP ](./ldap.bulk.create.mail.users.html ) and
[MySQL/MariaDB/PostgreSQL ](./sql.bulk.create.mail.users.html ).
2015-07-07 08:09:17 -05:00
* If you're running a busy mail server, we have [some suggestions for better
performance](./performance.tuning.html).
2014-10-11 00:25:17 -05:00
## 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.
2015-12-10 06:51:58 -06:00
* __Roundcube webmail__: < https: // your_server / mail />
* __SOGo Groupware__: < https: // your_server / SOGo >
* __Web admin panel (iRedAdmin)__: < httpS: // your_server / iredadmin />
2014-10-11 00:25:17 -05:00
## Get technical support
2016-03-22 11:17:36 -06:00
* You are welcome to post issues, feedbacks, feature requests, suggestions in
2017-11-16 21:48:44 -06:00
our [online support forum ](https://forum.iredmail.org/ ), it's more
2019-02-09 20:11:36 -06:00
responsive than you expected.
2016-03-22 11:17:36 -06:00
* We offer paid professional support service too, check our web site for more
2017-11-16 21:48:44 -06:00
details: [Get Professional Support from iRedMail Team ](https://www.iredmail.org/support.html ).