...
Make a new directory of your choice and move the downloaded binary file (vrest_os_x_x_x) to this directory
Code Block $ mkdir vrest $ cd vrest vrest $ mv ~/Downloads/vrest_os_x_x_x .
- Set vREST Enterprise server configuration
In this new directory, create a new file `config.json`. A sample file content is attached below:
Code Block { "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, "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" } } }
- The above file contains the following configuration:
- port
Port Number on which, you want to execute vREST Enterprise server. - redirectToHTTPS
Boolean flag. If set to true, then any incoming requests with scheme HTTP will be redirected to HTTPS. - disableAllEmails
Boolean flag. If set to true, then vREST Enterprise server will stop sending any emails. - cookieSecret
Cookie secret. Set this to any secret string. - startOnHTTPS
Boolean flag. If set to true then vREST Enterprise server will try to start on HTTPS. If you set true, then please set appropriate configuration for port, httpsPrivateKeyPath, httpsCertificatePath. - httpsPrivateKeyPath
If startOnHTTPS config is set to true then provide the absolute file path of private key. - httpsCertificatePath
If startOnHTTPS config is set to true then provide the absolute file path of certificate file. - db
MongoDB connection string. For more information, please read this guide link. - disableAnalyticsTracking
By default, google analytics is enabled. We recommend you to keep this option enabled. If you want to disable google analytics, then you may set it to true. - disableLiveChat
By default, live chat option is enabled. If you want to disable live chat, then you may set it to true. - mail
Provide mail configuration here. Key `options` introduced in vREST 2.9.9 and here you may define other mail options such authMethod. For full options list, please visit NodeMailer Document.
- port
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:Code Block 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.
...