iredmail-doc/en_US/installation/0-install.iredmail.on.freeb...

7.4 KiB

Install iRedMail on FreeBSD

[TOC]

If you want to install iRedMail inside FreeBSD Jail, please use this installation guide instead: Install iRedMail inside FreeBSD Jail (with ezjail)

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 FreeBSD, you need:

  • A FRESH, minimal, working FreeBSD system, no additional ports or binary packages were installed. 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.
  • Make sure 3 UID/GID are not used by other user/group: 2000, 2001, 2002.

Note: All packages will be installed from ports tree.

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:

# hostname -f
mx.example.com

On FreeBSD, hostname is set in two files: /etc/rc.conf, /etc/hosts.

  • /etc/rc.conf: set hostname.
# Part of File: /etc/rc.conf
hostname="mx.example.com"
  • /etc/hosts: hostname <=> IP address mapping.
# 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, please reboot server to make it work.

# hostname -f
mx.example.com

Update ports tree via portsnap

# portsnap fetch extract update

Install package bash-static, it's required by iRedMail

# -- For FreeBSD 9 or earlier releases --
# pkg_add -r bash-static

# -- For FreeBSD 10 or later releases --
# pkg install bash-static

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

!!! note "Note to Chinese users"

Our domain name `iredmail.org` has been blocked in mainland China for
years (since Jun 04, 2011), please run command below to finish the
installation:

`IREDMAIL_MIRROR='https://dl.iredmail.org' bash iRedMail.sh`

Screenshots of installation:

  • Welcome and thanks for your use

{: width="700px" }

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

{: width="700px" }

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

{: width="700px" }

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

{: width="700px" }

!!! 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`.
  • Add your first mail domain name

{: width="700px" }

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

{: width="700px" }

  • Choose optional components

{: width="700px" }

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.

{: width="700px" }

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.

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.

Get technical support