
   AXIGEN Mail Server v1.1.0
   =========================
   Content of this document:

   1. Introduction
   2. Hardware requirements
   3. Software requirements
   4. Files and directories
   5. Configuration
   6. Initial setup
   7. Starting/Stopping the server

   1. Introduction
   ===============

   This software kit is the evaluation version of AXIGEN Mail Server.

   The Evaluation version
   Contains  all  features,  works for unlimited users and domains and is
   limmited  in  time  to  30 days. Technical support is available during
   evaluation.

   After Evaluation
   Should  you  be  happy  with evaluating AXIGEN, there is a very simple
   process  to  use one of the available AXIGEN Editions, keeping all the
   configuration  alive. All you have to do is to install the License key
   received.

   AXIGEN StartUp Edition - FREE
   The  StartUp  Edition is a commercial version, at a promotional price,
   FREE  of  CHARGE,  dedicated to start-up companies with no more than 9
   users and 1 domain. It also includes Basic technical support. In order
   to   use   the   StartUp  Edition  you  simply  have  to  register  on
   www.axigen.com and you will receive the License Key

   AXIGEN Business Edition
   The Business Edition is a commercial version with a price depending on
   the number of mailboxes, unlimited domains and 10 discussion lists. It
   also  includes  Basic  technical  support  free.  In  order to use the
   Business    Edition,    you    have    to    purchase    AXIGEN   from
   http://www.axigen.com/estore  or  from  your  nearest  AXIGEN  partner
   http://www.axigen.com/partners. After receiving the Registration Code,
   you  should  use it to register on www.axigen.com and receive your own
   License Key.

   Contacts:

   Technical Support
   -----------------
   Telephone: +40-21-303-20-89
   Email: support@axigen.com

   Sales
   -----
   Telephone: +40-21-303-20-80
   Email: international.sales@axigen.com

   See more details on www.axigen.com

   2. Hardware requirements
   ========================
   The minimum hardware requirements, for AXIGEN, are:
   * CPU: Intel Compatible x86, frequency >= 300 MHz
   * RAM: size >= 128 MB
   *  Available  space on HDD: 50 MB free space for installation purposes
   and default configuration files.

   3. Software requirements
   ========================
   The software requirements, for AXIGEN, are:
   * OS Linux, kernel 2.4/2.6
   * glibc >= 2.2.93
   * libstdc++ >= 3.2
   libstdc++ <= 4.0

   4. Files and directories
   ========================
   The  files and directories provided in the installation kit, needed by
   AXIGEN to run correctly, are:

   /etc/init.d/

   /etc/init.d/axigen
   *  this  is  the  initscript  of AXIGEN that will start the daemon for
   Gentoo, Debian, RedHat and SUSE distributions

   /etc/rc.d/rc.axigen
   *  this  is the initscript of AXIGEN that will start the daemon in the
   Slackware distribution

   /etc/conf.d/axigen
   *  This is the configuration file used by the AXIGEN initscript in the
   Gentoo distribution.

   /opt/axigen/
   /opt/axigen/bin/

   /opt/axigen/bin/axigen
   * AXIGEN daemon

   /opt/axigen/bin/provisioner
   *  an  executable to be used for managing domains and accounts through
   the provision socket

   /opt/axigen/bin/mqview
   *  an  executable  to  be  used  for  viewing the status of the queued
   messages

   /opt/axigen/bin/sendmail
   * binary to send mails from command line interface

   /opt/axigen/lib/

   /opt/axigen/lib/lib_filters.h
   /opt/axigen/lib/libaxifilter.so.3.1.2
   *  the  C  header  file  and  the  dynamic library for the AXIGEN FAPI
   (Filters API)

   /opt/axigen/share/
   /opt/axigen/share/doc/

   /opt/axigen/share/doc/README
   * a copy of this file

   /opt/axigen/share/doc/INSTALL
   * document containing the installation instructions

   /opt/axigen/share/doc/UNINSTALL
   * document containing instructions for uninstalling AXIGEN Mail Server

   /opt/axigen/share/doc/LICENSE
   * document containing the license for AXIGEN

   /opt/axigen/share/doc/LICENSE.pcre
   /opt/axigen/share/doc/LICENSE.ssl
   /opt/axigen/share/doc/LICENSE.icu
   /opt/axigen/share/doc/LICENSE.bsd
   *  documents  for  various  external  library  collections included in
   AXIGEN (OpenSSL, PCRE, ICU)

   /opt/axigen/share/doc/FAPI.txt
   /opt/axigen/share/doc/FAPI-Functions.txt
   * AXIGEN FAPI Specifications

   /opt/axigen/share/examples/

   /opt/axigen/share/examples/axigen.cfg
   /opt/axigen/share/examples/domain.cfg
   /opt/axigen/share/examples/account.cfg
   /opt/axigen/share/examples/maillist.cfg
   * sample configuration files

   /opt/axigen/share/examples/Makefile
   /opt/axigen/share/examples/test_axifilter.cpp
   *  example  of  filter  made  using  the  AXIGEN  FAPI, along with the
   Makefile needed for it to be built

   /var/opt/
   /var/opt/axigen/

   /var/opt/axigen/run/axigen.cfg
   * main configuration file for the server

   /var/opt/axigen/webmail/
   *  default  directory  used  for  storing  files  pertaining to AXIGEN
   Webmail module.

   /var/opt/axigen/webmadmin/
   *  default  directory  used  for  storing  files  pertaining to AXIGEN
   Webadmin module.

   5. Configuration
   ================
   *   Per   server   (general)  configuration  settings  reside  in  the
   /var/opt/axigen/run/axigen.cfg file.
   * Domains and accounts can be managed via the WebAdmin or CLI modules,
   or via the provisioner tool.
   *  Everytime  a  change  is made in the configuration file, the server
   must  be reloaded, in order for the new configuration settings to take
   effect.  In  the  administration  modules, there are special functions
   that don't require server reload

   More information about each configuration setting, can be found in the
   example  configuration  files,  as  comments,  or in the online manual
   located at http://www.axigen.com/

   6. Initial setup
   ================

   **** Setting the AXIGEN admin password

   Before  accessing  the  webadmin  interface it is mandatory to set the
   AXIGEN admin password. This can be done the following way:
   - Run axigen only with -A (or --admin-passwd) option
   /opt/axigen/bin/axigen -A your_admin_password_here
   -  Restart  the  server  (see  section  "Starting/Stopping the server"
   section)

   NOTE: You can use the password only with "admin" username.

   **** Enabling the WebAdmin Interface

   By  default,  the Webadmin module listens to the 9000/tcp port and can
   be  enabled  by  editing  the  AXIGEN  configuration file (by default:
   /var/opt/axigen/run/axigen.cfg) and setting in the webadmin{} context,
   the default listener:

   webadmin = {
   ...
   listeners = (
   {
   address = 127.0.0.1:9000
   enable = yes
   ...
   }
   ...

   -  Restart  the  server  (see  section  "Starting/Stopping the server"
   section)

   -  Type:  http://127.0.0.1:9000/  in  the  browser and login using the
   'admin' user and the password you have previously set.

   NOTE: If you access the WebAdmin from another machine, you need to set
   in the listener's "address" parameter, the IP number of the machine on
   which  AXIGEN  is installed, or the "0.0.0.0" IP, which will listen on
   all machine interfaces. When accessing the AXIGEN Webmail, you need to
   replace  the  "127.0.0.1"  IP from the URL, with the IP address of the
   machine on which AXIGEN is installed.

   **** Creating the initial domain database

   Starting with the 1.1.0 release version, an initial domain database is
   created  automatically  when  starting  server  for the first time, in
   /var/opt/axigen/domains

   NOTE:  You  can  change the domain database location anytime using the
   Server -> Domain dB Locations page in the WebAdmin tool.

   **** Adding a domain to the domain database

   In order to add a domain, please follow the steps below:
   - Click on the "Domains" tab
   -  Fill  the  text  box "Domain name" with the domain name you want to
   create
   - Check if the domain database is selected in "Domain db" box
   -  Press  the  "Add  new domain" button, edit the domain parameters or
   leave them to default values
   -  Press  the  "Update" button followed by the "Commit" button (in the
   top of the page)

   **** Adding an account in an existing domain

   For adding the new account in the domain, in the WebAdmin page:
   - Click on "Accounts" tab
   -  Click  on  "Show  Accounts"  button for choosing the domain through
   which you want to handle the account
   - Type the account name in the "Account name", edit box
   - Click on "Add new account"
   - Set other preferences for the account
   - Click on the "Commit" button for finishing the process of adding the
   new account

   7. Starting/Stopping the server
   ===============================
   In  RedHat,  Debian,  Gentoo and SUSE distributions, you can start the
   server with the following command:

   /etc/init.d/axigen start

   To stop the server, you can issue:

   /etc/init.d/axigen stop

   In order to restart AXIGEN daemon, you can use:

   /etc/init.d/axigen restart

   To  reload  AXIGEN daemon (i.e. for new configuration settings to take
   effect), you can pass the 'reload' parameter to the initscript:

   /etc/init.d/axigen reload

   To view the AXIGEN daemon status, you can pass the 'status' parameter:

   /etc/init.d/axigen status

   In   Slackware,  you  can  use  the  same  commands,  applied  to  the
   /etc/rc.d/rc.axigen  initscript,  instead  of /etc/init.d/axigen, e.g.
   for starting the server, you can issue:

   /etc/rc.d/rc.axigen start
