Installing FalconCMS Pro β
FalconCMS is open-core. The free falconcms/falconcms package (MIT, on public Packagist) gives you the CMS, page builder, themes, menus, media, hooks API β and the full e-commerce system (storefront, cart, checkout, orders, coupons), which is now part of the free core.
Pro unlocks the remaining commercial features:
- Multi-language β translated content and language switching
- Analytics β dashboard insights and reports
- Advanced page builder β the Pro elements, Library and Global Sections
- Custom fields β ACPT field groups
- Advanced login β multi-device & magic login
- Falcon Slider β the layer-based slider builder (docs)
Pro ships as a separate, proprietary package β falconcms/pro β delivered from a private repository. It is never bundled in the free download, so you install it with Composer using the credentials you receive when you buy a license.
You need two things
- A license key (
PRO-β¦orAGENCY-β¦) β activates the features inside the dashboard. - An access token β lets Composer download the private
falconcms/propackage.
Both are emailed to you right after purchase. The license key is public-facing; keep the access token secret β treat it like a password.
Downloading the code and unlocking the features are two separate steps: the access token gets the code onto your server (Composer), and the license key turns the features on (in the dashboard).
Requirements β
- FalconCMS core v2.0 or higher (
composer show falconcms/falconcms) - PHP 8.1+
- Composer 2.x
If you are on core v1.x, upgrade to v2 first.
Install from the dashboard (recommended) β
FalconCMS can install Pro for you β no terminal needed:
- Open your dashboard β Falcon Builder β License.
- Paste your license key (
PRO-β¦orAGENCY-β¦) and click Activate. The key is saved; the page notes that the Pro package still needs installing. - In the same page, paste your access token and click Save token & install Pro. FalconCMS writes your
auth.json, adds the private repository and runscomposer require falconcms/proon the server (this can take up to a minute). - Reload the page β the status card turns green and every Pro feature unlocks.
That's the whole flow. Under the hood it does exactly the manual steps below, so use those if your host blocks server-side Composer (some shared hosts disable exec()).
Install manually (fallback) β
Run these in your project root, using the access token from your purchase email.
1. Add the private repository:
composer config repositories.falconcms-pro vcs https://github.com/falconcms/falconcms-pro.git2. Create an auth.json next to composer.json (Composer reads it automatically β a file avoids copy-paste/escaping issues with the long token):
{
"github-oauth": {
"github.com": "YOUR-ACCESS-TOKEN"
}
}Never commit the token
Add auth.json to your .gitignore. For servers and CI, see Deploying to production.
3. Install:
composer require falconcms/pro4. Activate: dashboard β Falcon Builder β License β paste your license key β Activate.
Updating Pro β
From the dashboard β
Pro updates ride along with the core updater β Dashboard β Updates β Run Update Now refreshes both. To bump only Pro, re-run the install (or use the command below).
Manually β
composer update falconcms/proOr update both together:
composer update falconcms/falconcms falconcms/proKeep core and Pro in step
Pro requires a matching core major version. When you move to a new core major (e.g. v2 β v3), update both at once so their constraints resolve.
Deploying to production β
Your production server and CI pipeline also need the access token to install Pro. Pick whichever fits your setup β do not hard-code the token in tracked files.
Option A β auth.json on the server (git-ignored):
{
"github-oauth": {
"github.com": "YOUR-ACCESS-TOKEN"
}
}Option B β environment variable (great for CI / Docker):
export COMPOSER_AUTH='{"github-oauth":{"github.com":"YOUR-ACCESS-TOKEN"}}'
composer install --no-devTroubleshooting β
βAccess token saved, but the Pro package could not be installed automatically.β Your host can't run Composer from the browser (or the project isn't writable). The token is still saved β just follow Install manually, starting at step 1.
βThis license key is not valid.β The key wasn't recognised. Double-check you pasted it in full (no spaces). If it still fails, deactivate and try again, or contact support with your order reference.
βThis license key has reached its activation limit.β The key is already active on another site (Pro allows one site). Deactivate it there first β Falcon Builder β License β Deactivate frees the slot so you can activate here.
βKey saved, but Pro is not active.β The key is valid but the falconcms/pro package isn't installed yet. Paste your access token on the License page (or install manually).
Composer: Could not authenticate / 404 on github.com The access token is missing or wrong. Re-check your auth.json, and confirm the token from your purchase email hasn't been revoked.
Lost your key or token?
Contact support with your order reference. A leaked access token can be revoked and reissued without affecting your license key.
