Environment variables
Environment variables available in Front-Commerce are the configurations that are likely to change depending on the current environment of your application.
Environment variables documented in this guide can be defined in three different ways:
- on your server (See How To Read and Set Environmental and Shell Variables on a Linux VPS)
- in the
.env
file in your root folder - For FC Cloud users: on Cockpit, under the "Environment" tab
Front-Commerce related variables
You can find the environment variables related to Front-Commerce in this article.
Theme Chocolatine
You can find the environment variables related to Theme Chocolatine in this article.
Remote services configuration
Your Front-Commerce application is an empty shell if it's not connected to remote services. These following sections document which variables are needed for each one of these.
Magento 2
You can find the environment variables related to Magento 2 in this article.
Magento 1
You can find the environment variables related to Magento 1 in this article.
Gezy
You can find the environment variables related to Gezy in this article.
Adobe B2B
You can find the environment variables related to Adobe B2B in this article.
Google Maps
You can find the environment variables related to Google Maps in this article.
Algolia
You can find the environment variables related to Algolia in this article.
Adyen
You can find the environment variables related to Adyen in this article.
Hipay
You can find the environment variables related to Hipay in this article.
Paypal
You can find the environment variables related to Paypal in this article.
Payzen
You can find the environment variables related to Payzen in this article.
Stripe
You can find the environment variables related to Stripe in this article.
Prismic
You can find the environment variables related to Prismic in this article.
Contentful
You can find the environment variables related to Contentful in this article.
External login providers
Facebook
You can find the environment variables related to Facebook login provider in this article.
Google
You can find the environment variables related to Google login provider in this article.
Build related variables
NODE_ENV
:"development"
or"production"
a variable heavily used in the javascript ecosystem to let you add checks only on the development environment (warnings, guards, etc.)
Debugging
Find all the debug flags in this article.
FRONT_COMMERCE_DEBUG_TOKEN
(default:""
): A token required to access debug pages (/__front-commerce/debug
). When set, provides access to debugging features through a secure token.
Deprecation warnings
Front-Commerce leverages the depd package to show deprecation warnings so you can upgrade your codebase for compatibility with the next major version.
A meaningful module name is used to scope depd
messages, and appears at the
beginning of every output line.
One can leverage
depd
's TRACE_DEPRECATION
environment variable
to display a stack trace for each deprecation. It will help you to find the line
of code in your codebase that calls deprecated code.
NO_DEPRECATION
(default:""
): Namespace of deprecation warnings to ignore. See depd package documentation for more detailsTRACE_DEPRECATION
(default:""
): Namespace of deprecation warnings to trace. See depd package documentation for more details
Add your own environment variables
Depending on the amount of customization you add to your Front-Commerce application, you may need to add new environment variables. Follow this guide.