WebMail Lite Documentation

Installing from repository

For production use of WebMail Lite, installing from ZIP package is a recommended approach. For development or testing purposes, you can install the product from repository as described below.

During installation process you will need:

  1. Download and unpack the latest version of WebMail Lite into your installation root directory https://github.com/afterlogic/webmail-lite-8/archive/latest.zip

  2. composer.phar file is available in repository, but you can download its latest version 2 from https://getcomposer.org/composer.phar

  3. Start the composer installation process by running the following from the command line:

    php composer.phar install

    NB: It is strongly advised to run composer as non-root user. Otherwise, third-party scripts will be run with root permissions and composer issues a warning that it's not safe. We recommend running the script under the same user web server runs under.

  4. Next, you need to build static files for the current module set.

    First of all, install all npm dependencies via

    npm install

    then install the dependencies required for adminpanel to work

    cd modules/AdminPanelWebclient/vue
    npm install
    npm install -g @quasar/cli

    or you can execute all the actions mentioned above by using the following command

    chmod +x builder.sh
    ./builder.sh -t npm
  5. Now you can build static files. Run the following commands in main directory:

    npm run styles:build --themes=Default,DefaultDark,DeepForest,Funny,Sand
    npm run js:build
    npm run js:min

    and build adminpanel

    cd modules/AdminPanelWebclient/vue
    npm run build-production

    or use all-in-one command

    ./builder.sh -t build    
  6. Now you are ready to open a URL pointing to the installation directory in your favorite web browser. Be sure to add /adminpanel/ to main URL to access admin interface.

  7. Upon installing the product, you'll need to configure your installation.

IMPORTANT:

  1. Make sure data directory is writable by the web server. For example:

    chown -R www-data:www-data /var/www/webmail/data
  2. It is strongly recommended to run the product via https. If you run it via http, the majority of features will still be available, but some functionality aspects, such as authentication with Google account, won't work.

To enable automatic redirect from http to https, set RedirectToHttps to true in data/settings/config.json file.

Protecting data directory:

All configuration files of the application and user data are stored in data directory, so it's important to protect data directory to make sure that nobody can access that directory over the Internet directly.