iredmail-doc/installation/2-install.iredmail.on.freeb...

221 lines
7.4 KiB
Markdown

# Install iRedMail on FreeBSD (without Jail)
[TOC]
> If you want to install iRedMail inside FreeBSD __Jail__, please use
> this installation guide instead:
> [Install iRedMail inside FreeBSD Jail (with ezjail)](http://www.iredmail.org/wiki/index.php?title=Install/iRedMail/FreeBSD.Jail)
## 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 modifing,
> and it may be not working as expected.
To install iRedMail on FreeBSD, you need:
* A FRESH, minimal, working FreeBSD system, no addition ports or binary
packages were installed. Supported releases are listed on
[Download](../download.html) page.
* At least `1 GB` of memory is required for low traffic production server.
Spam/Virus scanning will take most system resource.
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:
```shell
# 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
```bash
# -- 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](../download.html) 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
> 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.
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.
```
# cd /root/iRedMail-x.y.z/
# bash iRedMail.sh
```
## Screenshots of installation:
* Welcome and thanks for your use
![](../images/installation/iredmail/welcome.png)
* Specify location to store all mailboxes. Default is `/var/vmail/`.
![](../images/installation/iredmail/location_to_store_mailboxes.png)
* Choose backend used to store mail accounts. You can manage mail accounts
with iRedAdmin, our web-based iRedMail admin panel.
__IMPORTANT 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.
![](../images/installation/iredmail/backend.png)
* If you choose to store mail accounts in OpenLDAP, iRedMail installer will
ask you two questions about OpenLDAP.
LDAP suffix.
![](../images/installation/iredmail/ldap_suffix.png)
Password of LDAP root dn.
![](../images/installation/iredmail/pw_of_ldap_root_dn.png)
* Set password of MySQL or PostgreSQL admin user.
__NOTE__: MySQL is used to store data of other applications (e.g. Roundcube
webmail, Cluebringer, Amavisd-new) if you choose OpenLDAP or MySQL as backend.
![](../images/installation/iredmail/pw_of_mysql_root_user.png)
* Add your first mail domain name
![](../images/installation/iredmail/first_mail_domain.png)
* 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.
![](../images/installation/iredmail/pw_of_domain_admin.png)
* Choose optional components
![](../images/installation/iredmail/optional_components.png)
After answered above questions, iRedMail installer will ask your confirm to
start installation. It will install and configure required packages
automatically. Type `y` or `Y` and press `Enter` to start.
```
Configuration completed.
*************************************************************************
**************************** WARNING ***********************************
*************************************************************************
* *
* Please do remember to *REMOVE* configuration file after installation *
* completed successfully. *
* *
* * /root/iRedMail-x.y.z/config
* *
*************************************************************************
<<< iRedMail >>> Continue? [Y|n] # <- Type 'Y' or 'y' here, and press 'Enter' to continue
```
## Important things you __MUST__ know after installation
* Read file `/root/iRedMail-x.y.z/iRedMail.tips` first, it contains:
* URLs, usernames and passwords of web-based applications
* Location of mail serve related software configuration files
* Some other important and sensitive information
* [Setup DNS records for your mail server](./setup_dns.html)
* [Configure Thunderbird as mail client (POP3/IMAP, SMTP and global ldap address book)](./configure.thunderbird.html)
## 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/](https://your_server/mail/)
* __Web admin panel (iRedAdmin)__: [httpS://your_server/iredadmin/](httpS://your_server/iredadmin/)
* __phpLDAPadmin__ (available if you choose LDAP backend): [httpS://your_server/phpldapadmin/](httpS://your_server/phpldapadmin/)
* __Awstats__: [httpS://your_server/awstats/awstats.pl?config=web](httpS://your_server/awstats/awstats.pl?config=web) (or ?config=smtp)
## Get technical support
Please post all issues, feedbacks, feature requests, suggestions in our [online
support forum](http://www.iredmail.org/forum/), it's more responsible than you
expected.
## Notes about binary packages provided by iRedMail project
Most binary packages in iRedMail yum repository comes from below repositories,
packages with `-ired` flag were packed by iRedMail project.
* [Dag Wieers](http://packages.sw.be/)
* [EPEL](http://download.fedora.redhat.com/pub/epel/)
* [ATrpms](http://atrpms.net/)