Docs for all releases
This documentation relates to an earlier version of JeraSoft VCS.
View User Guide 3.26 or visit our current documentation home page.
View User Guide 3.26 or visit our current documentation home page.
In this article
Configuration File
The next step is to tune Client Panel settings. In order to do this, you will need to modify customer-params.json file located in /opt/jerasoft/vcs/portal-backend/config directory. This file is pre-created for you during system installation and has all required basic settings. However, if you're planning to use payment gateways: either PayPal or Authorize.Net, you must update values in respective fields of the file. In the same folder, you can find customer-params.default.json file containing default settings, explanations for which are given below.
Attention
Starting from VCS 3.16.x, customer-params.json is a symlink to /opt/jerasoft/vcs-data/conf/cp-customer-params.json file, and will be preserved through VCS upgrades.
Configuration Options
Below we provide a description of all settings you can find in customer-params.default.json and customer-params.json files:
| customer-params.default.json | ||
|---|---|---|
Setting Name | Description | Example |
| coreApi.uri | URL for the Core API JSON-RPC service | "http://127.0.0.1:3080" |
managementApi.uri | URL for the Management API | "https://127.0.0.1/jsonrpc" |
billingUri | Admin Panel web-address | "https://127.0.0.1" |
| openedEndpoint | Link where payment gateways webhook will be returned to (must be without slash at the end) | "https://127.0.0.1" |
| redisMain.hostname | The hostname or ip address to use for connecting to the redis server. | "localhost" |
| redisMain.port | The port to use for connecting to the redis server. | 6379 |
| redisMain.database | The redis database to use. | 1 |
| redisCache.hostname | The hostname or ip address to use for connecting to the redis server. | "localhost" |
| redisCache.port | The port to use for connecting to the redis server. | 6379 |
| redisCache.database | The redis database to use. | 2 |
| customer-params.json | ||
|---|---|---|
Setting Name | Description | Example |
| coreApi.authToken | CoreAPI Auth Token (could be found in the Users > CoreAPI Token field) | "a4386b81a8d062f640f1d1edaa821a9c" |
| managementApi.login | Login of the user under which all request will be performed (should be same user for which you use CoreAPI Auth Token) | "login" |
| managementApi.passsword | Password of the user under which all request will be performed | "password" |
Payment Gateways: PayPal
Check your PayPal panel for the required parameters. Get more details.
Setting Name | Description | Example |
|---|---|---|
| paypal.clientId | PayPal Client ID | |
| paypal.clientSecret | PayPal Client Secret Key | |
| paypal.sandbox | Defines PayPal working mode. Default working mode is live | false |
Payment Gateways: Authorize.net
Check your Authorize.Net panel for the required parameters. Get more details.
Setting Name | Description | Example |
|---|---|---|
authorizenet.apiLoginId | Authorize.Net API Login ID | |
authorizenet.apiTransactionKey | Authorize.Net API Transaction Key | |
| authorizenet.apiSignatureKey | Authorize.Net API Signature Key | |
| authorizenet.sandbox | Defines Authorize.Net working mode. Default working mode is live | false |
Attention
Payment Gateways integration requires proper domain name and real SSL certificate. Please check Panel Deployment guideline to get more information.
Overview
Content Tools