Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/afterlogic/webmail-lite-8

Open-source webmail script for existing IMAP server
https://github.com/afterlogic/webmail-lite-8

composer javascript knockoutjs php webmail

Last synced: 4 days ago
JSON representation

Open-source webmail script for existing IMAP server

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/afterlogic/webmail-lite-8.svg?branch=master)](https://travis-ci.org/afterlogic/webmail-lite-8)



# Afterlogic WebMail Lite

Open-source webmail script for your existing IMAP server.



- For more information, please visit WebMail Lite [home page](https://afterlogic.org/webmail-lite).

- You can check WebMail Lite [live demo](https://lite.afterlogic.com).

- [Github repository](https://github.com/afterlogic/webmail-lite-8)

- [Issue tracker](https://github.com/afterlogic/webmail-lite-8/issues)



![Afterlogic WebMail Lite: Message List](https://afterlogic.org/images/products/wml8/afterlogic-webmail-lite-8-message-list.png)



You can download WebMail Lite from our website, unzip the package and configure the installation as described at [this documentation page](https://afterlogic.com/docs/webmail-lite-8/installation/installation-instructions). This is a simple approach convenient for those who simply wish to install the product. But if you're looking for building and adding custom modules or skins, installing from Git repository is recommended per the instructions below.



## Installation instructions



During installation process you will need:

* [Git](https://git-scm.com/downloads)

* [Composer](https://getcomposer.org/download/)

* [Node.js + NPM](https://nodejs.org/en/)

    

    **Note!** npm 3.0 or later is required.



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`](https://github.com/afterlogic/webmail-lite-8/archive/latest.zip)



We're assuming that you wish to install the latest stable version of the product. If you're looking for the latest code (e.g., to contribute changes), the following steps needs to be taken:



- Instead of unpacking the archive, clone the repository into the installation directory:

```

git clone https://github.com/afterlogic/webmail-lite-8.git INSTALL_FOLDER_PATH

```

- change modules' versions in `composer.json` file to "dev-master"



1. `composer.phar` file is available in repository, but you can download its latest version 2 from [`https://getcomposer.org/composer.phar`](https://getcomposer.org/composer.phar)



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

    ```bash

    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.



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

      First of all, install all npm dependencies via

      ```bash

      npm install

      ```

      then install the dependencies required for adminpanel to work 

      ```bash

      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

	  ```



4. Now you can build static files. Run the following commands in main directory

      ```bash

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

      npm run js:build

	  npm run js:min

      ```

      and build adminpanel 

      ```bash

      cd modules/AdminPanelWebclient/vue

      npm run build-production

      ```

	  or use all-in-one command

	  ```

	  ./builder.sh -t build

	  ```

  

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



6. Upon installing the product, you'll need to [configure your installation](https://afterlogic.com/docs/webmail-lite/configuring-webmail).



**IMPORTANT:**



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

  ```bash

  chown -R www-data:www-data /var/www/webmail/data

  ```



2. It is strongly recommended to runs 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](https://afterlogic.com/docs/webmail-lite/security/protecting-data-directory) to make sure that  nobody can access that directory over the Internet directly. 



# Licensing

This product is licensed under AGPLv3. The modules and other packages included in this product as dependencies are licensed under their own licenses.



NB: Afterlogic Aurora modules which have dual licensing are licensed under AGPLv3 within this product.