Updated docs since refactoring payment
Mark Moffat
parent
b74d17bff7
commit
7b6a415a5a
22
README.md
22
README.md
|
|
@ -162,14 +162,14 @@ Note: The `databaseConnectionString` property requires a full connection string.
|
|||
|
||||
Settings can be managed from the admin panel ([http://127.0.0.1:1111/admin](http://127.0.0.1:1111/admin)) with the exception of the Payment gateway and database settings.
|
||||
|
||||
All settings are stored in json files in the `/config` directory. The main application-level settings are stored in `/config/settings.json` while payment gateway settings are stored in files in the `/config` directory named after the payment gateway. For example, configuration for the Stripe payment gateway is stored in `/config/stripe.json`.
|
||||
All settings are stored in json files in the `/config` directory. The main application-level settings are stored in `/config/settings.json` while payment gateway settings are stored in files in the `/config` directory named after the payment gateway. For example, configuration for the Stripe payment gateway is stored in `/config/payment/config/stripe.json`.
|
||||
|
||||
Configs are validated against the schema files. For the `settings.json` this will be validated against the `settingsSchema.json` file. The Payment gateway config is validated agaist the `/config/payment/schema/<gateway>.json` file.
|
||||
|
||||
##### Local configuration
|
||||
|
||||
If you'd rather store settings in a file which isn't checked into version control, you can create a new settings file at `/config/settings-local.json` and store your complete settings there. When viewing or editing settings in the admin panel, expressCart will detect the existence of this file and update it accordingly.
|
||||
|
||||
This can also be used for payment modules too. Any settings in the `/config/<gateway>-local.json` file will override the `/config/<gateway>.json` file.
|
||||
|
||||
##### Environment configuration
|
||||
|
||||
An alternative to local configuration is using an `env.yaml` file (in the root of app) to override settings. You may want to do something like:
|
||||
|
|
@ -185,6 +185,8 @@ production:
|
|||
|
||||
The app will read in the `NODE_ENV` and switch and override any valid settings. Eg: `databaseConnectionString` set in the `env.yaml` file will override anything in `settings.json` file (including local).
|
||||
|
||||
This can also be used for payment modules too. Any settings in the `env.yaml` file will override the `/config/payment/config/<gateway>.json` file.
|
||||
|
||||
##### Cart name and Cart description
|
||||
|
||||
These values are used for search engine optimization (SEO) purposes. They will be used as the title and description when your website is listed in Google and other search engines.
|
||||
|
|
@ -206,7 +208,7 @@ This email is used for any email receipts which are sent by your website.
|
|||
|
||||
##### Payment Gateway
|
||||
|
||||
This determines which payment gateway to use. You will also need to configure your payment gateway configuration file here: `/config/<gateway_name>.json`
|
||||
This determines which payment gateway to use. You will also need to configure your payment gateway configuration file here: `/config/payment/config/<gateway_name>.json` or use the `env.yaml` file.
|
||||
|
||||
##### Currency symbol
|
||||
|
||||
|
|
@ -245,7 +247,7 @@ will create a 'breadcrumb' menu at the top of the page
|
|||
|
||||
##### Paypal (Payments)
|
||||
|
||||
The Paypal config file is located: `/config/paypal.json`. A example Paypal settings file is provided:
|
||||
The Paypal config file is located: `/config/payment/config/paypal.json`. A example Paypal settings file is provided:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -260,7 +262,7 @@ Note: The `client_id` and `client_secret` is obtained from your Paypal account.
|
|||
|
||||
##### Stripe (Payments)
|
||||
|
||||
The Stripe config file is located: `/config/stripe.json`. A example Stripe settings file is provided:
|
||||
The Stripe config file is located: `/config/payment/config/stripe.json`. A example Stripe settings file is provided:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -280,7 +282,7 @@ Note: The `secretKey`, `publicKey` and `stripeWebhookSecret` is obtained from yo
|
|||
You have to configure the `HTTP Callback URL` parameter into Blockonomics -> Merchants -> Settings:
|
||||
http://CartURL/blockonomics/checkout_return where [**CartURL**](#cart-url) is the address of your server
|
||||
|
||||
The Blockonomics config file is located: `/config/blockonomics.json`. A example Blockonomics settings file is provided:
|
||||
The Blockonomics config file is located: `/config/payment/config/blockonomics.json`. A example Blockonomics settings file is provided:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -294,7 +296,7 @@ Note: The `apiKey` is obtained from your Blockonomics account.
|
|||
|
||||
##### Authorize.net (Payments)
|
||||
|
||||
The Authorize.net config file is located: `/config/authorizenet.json`. A example Authorize.net settings file is provided:
|
||||
The Authorize.net config file is located: `/config/payment/config/authorizenet.json`. A example Authorize.net settings file is provided:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -309,7 +311,7 @@ Note: The credentials are obtained from your Authorize.net account dashboard.
|
|||
|
||||
##### Adyen (Payments)
|
||||
|
||||
The Adyen config file is located: `/config/adyen.json`. A example Adyen settings file is provided:
|
||||
The Adyen config file is located: `/config/payment/config/adyen.json`. A example Adyen settings file is provided:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -326,7 +328,7 @@ Note: The `publicKey`, `apiKey` and `merchantAccount` is obtained from your Adye
|
|||
|
||||
##### Instore (Payments)
|
||||
|
||||
The Instore config file is located: `/config/instore.json`. A example Instore settings file is provided:
|
||||
The Instore config file is located: `/config/payment/config/instore.json`. A example Instore settings file is provided:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue