Logo

Messaging & Conferencing - Version 1.4.0


Introduction

  • Item Name : Clover Messaging & Conferencing
  • Item Version : v 1.4.0
  • Author : Honeyside
  • Support Forum : https://forum.honeyside.it
  • License : CodeCanyon Standard Licenses - You will need one Regular License for each installation of Clover. If you are planning to create and distribute a product of your own so that it will include the Clover original or modified source, you will need an Extended License.

First of all, Thank you so much for purchasing this item and for being my loyal customer. You are awesome!
With your purchase, you are entitled to get free lifetime updates to this product.

This documentation will show you all of Clover's features. Please go through the documentation carefully to understand how to configure your Clover messaging & conferencing system properly. No coding experience is required. In fact, you won't have to code at all! You will just have to edit a couple of configuration files and run a couple of scripts.

If you have questions or need support, please reach out using forum.honeyside.it, so that your questions will help future users with the same issue. If you don't want the trouble to go through the installation process yourself, contact us at support@honeyside.it in order to request paid installation service.

We will also answer to support requests via email for free (after requesting proof of purchase). However, we strongly recommend to use our forum, in order to help each other. Proof of purchase is not required for joining the forum or asking questions on the forum, because we value community above bureaucracy.

Requirements #back to top

Clover can run on any OS or machine that supports Node.js v12. However, in order to provide a safe environment for the unexperienced user, we recommend using Ubuntu 18.04 LTS. We provide fully automated installation (via installation script) and full installation instructions for Ubuntu 18.04 LTS only.

For the unexperienced user, we recommend buying a cheap Ubuntu 18.04 LTS VPS from OVH, then follow the Automated Install section. Choose a server next to your physical location (if you are in Europe, France is ok). We are not affiliated with OVH and we do not gain commission from your VPS purchase. It just happens to work well at the time of writing.

A domain is required. example.com is fine. clover.example.com is fine. whatever.example.com is fine. You will need to point your domain to your server. If you purchased a VPS from OVH, you will receive an IPv4 address for your VPS. Edit the domain's DNS records to point at your server (the IPv4 address), then wait 24 hours for propagation.

Clover will not run on a shared hosting. If you do not know the difference between shared hosting and private server, contact us at support@honeyside.it for paid installation service.

If your machine has cPanel or Plesk on it, it will most probably not be compatible with Clover, unless you perform a manual installation and you truly know what you are doing.

Automated Installation #back to top

Welcome to Clover: messaging & conferencing! Whether experienced user or not, it is always a pleasure to run a fully automated installation. Please be aware that the automated installer will work only on Ubuntu 18.04 LTS. We recommend installing Clover on a clean server.

Installation - #back to top

Connect to your server via SSH as root user, upload the Clover .zip archive and extract it in a location of your choice. cd into that location. Run ./install.sh DOMAIN EMAIL USERNAME PASSWORD FIRST_NAME LAST_NAME JWT_SECRET. DOMAIN is the domain name of your installation. It must be a domain and not an IP. EMAIL, USERNAME, PASSWORD, FIRST_NAME, LAST_NAME are the admin user. JWT_SECRET is a random string of your choice that will be used to encrypt user tokens. Wait for the process to complete, it will take some minutes.

At the end of the installation process, Clover will be reachable on port 443 SSL, with a Let's Encrypt certificate. Port 80 will automatically redirect to 443.

Ensure DNS propagation before running the script. Safest way is to wait 24 hours after changing your DNS records.

Manual Installation #back to top

You must have experience in server management to deploy the app manually. Do not attempt this if you do not know what you are doing. Contact us at support@honeyside.it in order to request a paid custom installation service or go back to Automated Installation.


Requirements - #back to top

You will need the following software installed in order to properly run Clover.

  1. MongoDB: check out MongoDB Community installation instructions.
  2. Build Essential: you will need a C++ compiler and possibly a Python compiler to install certain backend dependencies. In Ubuntu, this is handled using apt-get install build-essential.
  3. Node.js: you will need Node.js v12.15.0 or latest Node.js v12.
  4. Reverse Proxy: you will need a reverse proxy for SSL. You are free to choose between Acacia (developed by Honeyside), nginx and Apache.
The following software is highly recommended:
  1. Yarn: for dependency management, in place of npm.
  2. pm2: for process management.
  3. TURN server: for WebRTC full capabilities (otherwise you will be relying on Google's STUN server alone.

Installation - #back to top

  1. Extract archive contents.
  2. Install MongoDB on your system and ensure it is running.
  3. Install build essential package or equivalent for your system.
  4. Install Node.js v12. Using nvm (Node Version Manager) may help you manage your server later.
  5. cd into node and yarn or npm install all dependencies.
  6. Fill in node/config.js according to your needs.
  7. Run node/index.js.
  8. Install a reverse proxy and configure it so that it allows SSL connections and reverse proxies to the backend port (default 4000).
  9. Install a TURN server.
  10. cd into react and yarn or npm install all dependencies.
  11. Fill in react/src/config.js according to your needs. This is the place to add a TURN server to your servers.
  12. Don't forget to open ports 80 TCP, 443 TCP and 3478 TCP-UDP (TURN server) ... or whatever you did choose for your custom installation.

A thorough example of installation process is the install.sh file. You may want to take a look at that file and edit according to your needs.

Rebranding #back to top

In order to rebrand the app, edit the ./react/src/config.js configuration file.


                                            export default {
                                                /* iceServers should be generated automatically by the installation script.
                                                 * Do not touch this if you don't know what you are doing.
                                                 */
                                                iceServers: [
                                                    { urls: 'turn:YOUR_DOMAIN:3478', username: 'turn-user', credential: 'turn-psw' }, /* turn server, required only for clients behind nat */
                                                    { urls: 'stun:stun.l.google.com:19302' },
                                                ],
                                                demo: false,
                                                brand: 'YOUR COMPANY', /* Footer brand */
                                                appName: 'APP NAME', /* App Name */
                                                showCredits: false, /* Show credits in login page */
                                            };
                                        

Managing Users #back to top

When logging in as admin user (the one specified in the automated installer or in the config.js file), you'll see an administrative tab (CPU icon). You can add new users, edit or delete existing users from here.

Admin Interface Screenshot
Admin Interface Screenshot

Electron App #back to top

The Electron app can run both on Windows and macOS. In order to package the app, you will need to rebuild from source.

On your machine install Node.js v12 and Yarn, if you haven't already. Not your server, but your machine! If you want to build a binary for Windows, you must be using Windows. If you want to build a binary for macOS, you must be using macOS.

We can also build binaries for you (for a fee). Contact us at support@honeyside.it if you want to use this service.


                                    cd ./electron
                                    yarn install
                                    yarn global add electron electron-packager
                                
When building for Electron, you need to make the following change to your CLOVER_FOLDER/react/src/config.js

                                    {
                                        ...,
                                        url: 'YOUR_BACKEND_URL', // for example http://clover.honeyside.it
                                        demo: false,
                                    }
                                
When building for Electron, you need to make the following change to your CLOVER_FOLDER/react/public/index.html

                                    
                                
Then build the react for electron:

                                    cd ../react
                                    yarn build
                                    cd ../electron
                                    mkdir app
                                    cp ../react/build/* ./app/
                                
Now you can run locally your Electron app this way (while being in the electron folder):

                                    electron .
                                
Or you can package it:

macOS


                                    electron-packager . "Clover" --icon "./electron-icon.icns" --platform=darwin
                                

Windows


                                    electron-packager . "Clover" —-platform=win32
                                

Support #back to top

Please remember you have purchased a very affordable piece of software and you have not paid for a full-time software development agency. Occasionally we will help with small tweaks, but these requests will be put on a lower priority due to their nature. Support is also 100% optional and we provide it for your connivence, so please be patient, polite and respectful.

Please use the Honeyside Forum for support requests. This way, your questions will be available for all Honeyside users to be read and answered. You will also receive an official answer (or confirmation) from us as soon as possible. If you still prefer to contact us directly, visit our profile page or ask your question via our @Support email. If you chose the Forum, a huge thank you from us in advance!

Support for our items includes:
  • * Responding to questions or problems regarding the item and its features
  • * Fixing bugs and reported issues
  • * Providing updates to ensure compatibility with new software versions
Item support does not include:
  • * Customization and installation services
  • * Support for third party software and plug-ins
Before seeking support, please...
  • * Make sure your question is a valid Clover Issue and not a customization request.
  • * Make sure you have read through the documentation and any related video guides before asking support on how to accomplish a task.
  • * Make sure to take a look at the Honeyside Forum first.
  • * Make sure you are running Clover in a proper Node.js environment. See the Requirements section above for more.
  • * If you have customized your Clover installation and now have an issue, back-track to make sure you didn't make a mistake. If you have made changes and can't find the issue, please provide us with your changelog.
  • * Almost 80% of the time we find that the solution to people's issues can be solved with a simple "Google Search". You might want to try that before seeking support. You might be able to fix the issue yourself much quicker than we can respond to your request.
  • * Make sure to state the name of the item you are having issues with when requesting support via CodeCanyon.

Version History (Changelog) #back to top

Once again, thank you so much for purchasing Clover!


Changelog


                                        -----------------------------------------------------------------------------------------
                                        1.4.0 - June 2nd, 2020
                                        - Added screen sharing feature

                                        1.3.1 - April 14th, 2020
                                        - Added configuration options for easy rebranding in config file
                                        - Added documentation for rebranding options
                                        - Fixed Electron documentation issues

                                        1.3.0 - March 30th, 2020
                                        - added electron app
                                        - fixed call button issue not appearing on mobile
                                        - added demo mode switch in frontend config, defaults to false
                                        - fixed admin tab issues

                                        1.2.0 - March 5th, 2020
                                        - added administrative tab to create new users, update and delete existing users
                                        - added protected api routes that can be accessed only from the admin user

                                        1.1.1 - February 27th, 2020
                                        - frontend and backend can now be hosted on different servers

                                        1.1.0 - February 14th, 2020
                                        - added audio / video capabilities for mobile
                                        - fixed multiple details visualization issues in Safari
                                        - fixed contact list visualization issue in Safari
                                        - fixed contact list visualization issue on mobile devices

                                        1.0.1 - February 13th, 2020
                                        - minor bug fixing

                                        1.0.0 - February 11th, 2020
                                        - first version
                                        -----------------------------------------------------------------------------------------

                                      

Copyright and license #back to top

Clover is sold exclusively through CodeCanyon (Envato marketplace), where the CodeCanyon Standard Licenses apply.

You will need one Regular License for each installation of Clover. If you are planning to sell products that will include the Clover original or modified source, you will need an Extended License.

Copyright © Honeyside - All Rights Reserved

Unauthorized copying of the Clover source and/or executable files, via any medium, is strictly prohibited.