Software pre-requisites for the machine, on which you want to install vREST enterprise server:
Hardware requirements for the machine, on which you want to install vREST enterprise server:
Make a new directory of your choice and move the downloaded binary file (vrest_os_x_x_x) to this directory
$ mkdir vrest $ cd vrest vrest $ mv ~/Downloads/vrest_os_x_x_x . |
In this new directory, create a new file `config.json`. A sample file content is attached below:
{ "port" : "4000", "redirectToHTTPS" : false, "disableAllEmails" : false, "cookieSecret" : "your_db_secret", "startOnHTTPS" : false, "httpsPrivateKeyPath" : "privatekey.pem", "httpsCertificatePath" : "certificate.pem", "db" : "mongodb://localhost/vrest", "disableAnalyticsTracking" : false, "disableLiveChat" : false, "defaultUserPassword": null, "mail": { "host": "smtp.gmail.com", "secureConnection": "true", "port": 465, "username": "vrest.mailer@your-domain.com", "password": "email-password", "defaultFrom": "vREST Mail <vrest.mailer@your-domain.com>", "options": { "authMethod": "PLAIN" } } } |
Start the server
To start the server, first make sure that your MongoDB server is running and you have configured the config.json file. Now simply run the following command:
vrest$ chmod +x vrest_os_x_x_x vrest$ ./vrest_os_x_x_x |
That's it. Your vREST Enterprise server is ready and accessible from URL like this: http(s)://<computer_name_or_IP_address>:<port>. Please follow this guide link to install licence in your enterprise instance.
Note: Please make sure, you are accessing vREST Enterprise through public facing URL before generating the licence key.