Settings
Bison’s configuration file can be found in /_config/add-ons/bison/bison.yaml
.
It provides a number of sensible defaults (shown below the descriptions) but there are also some settings you will need to tend to before beginning.
Options
encryption_key
Required- Used to encrypt and decrypt data. You should set this to a strong 32 character passphrase. You can use an app like 1Password to generate one.
currency
- Currency used in payment gateway.
USD
product_folder
- The folder which contains your product entries.
If your products are located in multiple folders, you can use an array.
eg.['products', 'things']
products
unique_field
- The field to determine the products’ uniqueness. (title, url, or a custom field like sku for example)
title
price_field
- The field name of the prices in your products
price
option_field
- The field name of the product options / price modifiers
options
tax_rate
- Tax applied to cart (percentage)
0
tax_inclusive
- Do product prices include tax?
true
will not add tax to the cart total.false
will.
false
tax_rate_field
- Field name for overriding the tax rate on a product level
tax_rate
tax_free_field
- Field name for flagging a product as tax-free
tax_free
enable_tax_number_field
- Do you want to allow customers to enter a tax number (ie. VAT)?
false
tax_number_validation
:- How should the tax number be validated? (ie. A ensure
tax_number
is a valid VAT number)
vat
shipping_taxable
- Should shipping be taxed?
false
discounts_taxable
- Should discounts be included in the tax calculations?
true
shipping_method
- Shipping calculation method. More info.
payment_gateway
Required- Payment Gateway handle. Gateway specific settings can be found in the Gateways section.
order_save_to_file
- Orders can be saved to file
true
order_save_path
- Location (from root) to save orders
_content/orders/
order_extension
- Filename - if you plan on displaying on the frontend, use md.
md
order_id_prefix
- A string prepended to the start of the order ID
order_id_suffix
- A string appended to the end of the order ID
order_statuses
- An array of statuses you want to use for your orders. The first in the list will be the default. It can either be key/value pairs of name/label, eg.
paid: Paid
; or a regular list, eg.- paid
.
paid
order_status_colors
- The colors used in the control panel (but you can also use them in your templates with the order_status tag). This should be a key/value pairing of order statuses and colors. They can be any valid CSS color (hex, rgb, etc)
paid: green
email_handler
- The email handler used to send any emails. By default, PHP Mail will be used, but Bison can integrate with the following services:
mandrill
,mailgun
,postmark
andsendgrid
Each service requires your own account and an API key. email_handler_key
- If you are using an email service, your API key goes here.
emails
- This is an array that contains each email’s settings. More info.
discounts_folder
- Location (from root) to find discounts
_content/discounts
coupons_folder
- Location (from root) to find coupons
_content/discounts
create_members
- Whether to create members at checkout. More info
clear_customer_details
- Whether or not to clear the customer’s details from session at checkout
false
control_panel
- An array containing your control Panel specific options. More info
Problem with this page? Edit it on Github.