Docs for all releases
Page History
...
| Panel | ||
|---|---|---|
| ||
|
Configuration File
The next step is to tune Client Panel settings. If you are using default deployment the configuration is located at /opt/jerasoft/vcs-data/conf/cp-customer-params.json. If you are moving panel to the other host, the file should be located in <YOUR-PATH>/portal-backend/config/customer-params.json.
During the installation process the file is pre-created with all general settings like billing credentials, tokens, etc. At the same time there is a set of parameters that can be configured like:
- Payment gateway credentials
- Default locale and output settings
- Date and time formatting options
- Rates and costs rounding
In order to simplify the process your deployment provides file 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.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
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. |
...
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. This file has all the available settings with their default values. You do not need to change this file, it is provided as a reference.
Per Reseller Configuration
The structure of the your configuration file allows you to have different settings for different Resellers in the system. By default the file contains a single section called "default" with all custom settings. If you want to have multiple Client Panels (for example separated by domain names), you need to add another section with a simple distinguishable name and put all related settings in this section. The name may consist of latin characters, numbers, minus and underscore characters.
After that you need to pass this name from your web-server to the panel using FastCGI parameter called "CONFIG_ID". It will tell panel which part of config to read in order to display related Client Panel. If you are using nginx as your web server use following statement to pass the parameters:
| Code Block | ||||
|---|---|---|---|---|
| ||||
fastcgi_param CONFIG_ID "special"; |
Configuration Options
As mentioned above you can use /opt/jerasoft/vcs/portal-backend/config/customer-params.default.json file as a reference for all available parameters. The table below describes each of them. Please put all settings into your config file and do not change customer-params.default.json as it will be overwritten on the system update.
| General Settings [top-level] | ||
|---|---|---|
Setting Name | Description | Example |
| billingUri | URL of the billing system As it is accessible from the Client Panel host | "https://127.0.0.1" |
| companiesId | ID of the Reseller for the Client Panel | 3 |
logFile | Path to the Client Panel log file | "/opt/jerasoft/vcs-data/log/cp.log" |
| openedEndpoint | URL of the Client Panel (without "/" at the end) | "http://127.0.0.1" |
| coreApi.uri | URL of the Core API | |
Setting Name
Description
Example
| service | "http://127.0.0.1:3080" | |
| coreApi.authToken | Authorization token for the Core API service You can get this token in the "System / Users" section | "PW2Ln6PSS3vpmmZrCQBV5of2NO7jJbcU" |
| managementApi.uri | URL |
| of the Management API | "https://127.0.0.1/jsonrpc" | |
| managementApi.login | Login of the user used for the integration You need to have a dedicated user for the integration, use the same user for Core API service and Management API | "api-client-portal" |
| managementApi.password | Password of the user used for the integration | "aqGW31oxHag8" |
| Output Formatting [section: defaults] | ||
|---|---|---|
Setting Name | Description | Example |
| locale | Default locale to start with Available settings: en, ru | "en" |
| perPage | Quantity of rows to display per page Allowed values: integer 1 to 1000 | 10 |
| roundRates | Quantity of digits after decimal point for display of rates Allowed values: integer 0 to 16 | 4 |
| roundAmounts | Quantity of digits after decimal point for display of amounts Allowed values: integer 0 to 16 | 2 |
| Date and Time Formatting [section: dateTimeConfig] | ||
|---|---|---|
Setting Name | Description | Example |
| monthFormat | Format string for display of "Month Year" strings Please refer to the following guide for list of possible values | "F Y" |
| dateFormat | Format string for display of dates Please refer to the following guide for list of possible values | "m/d/Y" |
| dateTimeFormat | Format string for display of dates with time Please refer to the following guide for list of possible values | "m/d/Y, h:i A" |
| customer-params.default.json | ||
|---|---|---|
Setting Name | Description | Example |
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 |
Setting Name
Description
Example
CoreAPI Auth Token (could be found in the Users > CoreAPI Token field)
"a4386b81a8d062f640f1d1edaa821a9c"Login of the user under which all request will be performed (should be same user for which you use CoreAPI Auth Token)
"login"Payment Gateways: PayPal
Check your PayPal panel for the required parameters. Get more details.
...
Overview
Content Tools