# Install iRedMail on OpenBSD

## 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 modifying, and it may not be working as expected.

To install iRedMail on OpenBSD, you need:

- A FRESH, working OpenBSD system. Supported releases are listed on Download page.
- `2 GB` of memory is recommended for a 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

- Make sure 3 UID/GID are not used by other user/group: 2000, 2001, 2002.

Note

- All binary packages will be installed with command `pkg_add -i`. It will prompt you to choose different versions of binary packages, please choose the one described below:

  - choose `p5-Mail-SPF`, NOT `p5-Mail-SPF-Query`

- 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.

## 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` to view the current hostname:

    $ hostname
    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
    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.

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 bzip2

### Download the latest release of iRedMail

- Visit Download page 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 required to setup a full-featured mail server.

    # cd /root/iRedMail-x.y.z/
    # bash iRedMail.sh

To Chinese users

Our domain name `iredmail.org` is blocked in mainland China since Jun 04, 2011, please run command below to finish the installation:

`IREDMAIL_MIRROR='http://173.254.22.21' bash iRedMail.sh`

## Screenshots of installation:

- Welcome and thanks for your use

- Specify location to store all mailboxes. Default is `/var/vmail/`.

- Choose backend used to store mail accounts. You can manage mail accounts with iRedAdmin, our web-based iRedMail admin panel.

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.

- If you choose to store mail accounts in OpenLDAP, iRedMail installer will ask to set the LDAP suffix.

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`.

- Add your first mail domain name

- 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.

- Choose optional components

After answered above questions, iRedMail installer will ask you to review and confirm to start installation. It will install and configure required packages automatically. Type `y` or `Y` and press `Enter` to start.

## Important things you MUST know after installation

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.

- Read file `/root/iRedMail-x.y.z/iRedMail.tips` first, it contains:

  - URLs, usernames and passwords of web-based applications
  - Location of mail service related software configuration files. You can also check this tutorial instead: Locations of configuration and log files of major components.
  - Some other important and sensitive information

- Setup DNS records for your mail server

- How to configure your mail clients
- Locations of configuration and log files of major components
- It's highly recommended to get a SSL cert to avoid annonying warning message in web browser or mail clients when accessing mailbox via HTTPS/IMAPS/POP3/SMTPS. Let's Encrypt offers FREE SSL certificate. We have a document for you to use a SSL certificate.
- If you need to bulk create mail users, check our document for OpenLDAP and MySQL/MariaDB/PostgreSQL.
- If you're running a busy mail server, we have some suggestions for better performance.

## 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/
- SOGo Groupware: https://your_server/SOGo
- Web admin panel (iRedAdmin): httpS://your_server/iredadmin/
- Awstats: httpS://your_server/awstats/awstats.pl?config=web (or `?config=smtp` for SMTP traffic log)

## Get technical support

- You are welcome to post issues, feedbacks, feature requests, suggestions in our online support forum, it's more responsible than you expected.
- We offer paid professional support service too, check our web site for more details: Get Professional Support from iRedMail Team.