Requirements
- An Asterisk-based PBX: FreePBX 16 or 17, a FreePBX-derived fork, or VitalPBX. A PBX on FreePBX 14 or 15 that already has Call Flow Studio keeps updating, but a new install needs 16 or newer. The installer auto-detects. The operating system underneath doesn’t decide it: Call Flow Studio identifies the PBX from its own configuration, then checks PHP, your database, and Asterisk before changing anything. Verified on FreePBX 16 and 17, Incredible PBX, TangoPBX, VitalPBX 3 and 4.
- Root /
sudoon the PBX server. - Outbound HTTPS to
callflowstudio.ioandlicense.callflowstudio.io; allow both if your firewall works from a list. Not only at install: the PBX checks its license in every night and when someone signs in, so a box with no route out to us isn’t a fit. Nothing about your dial plan goes with it (everything the PBX sends us). Typing greetings and recordings in an AI voice also needs a route out to ElevenLabs or OpenAI, whichever you use. - About 60 MB of disk once installed: the web folder plus root’s own copy in
/usr/local/lib/cfstudio. While installing it also needs about 50 MB free in/tmp, and an update keeps the previous copies aside until the new one has worked.
Not supported: a new install on FreePBX older than 16. The installer detects this and stops with an explanation rather than installing something that won’t work.
Install
SSH to your PBX as root and run two commands. The bootstrap checks the current release’s signature, downloads it, checks its SHA-256 against the signed one, unpacks it in a folder only root can reach, and runs the release’s installer from there. There’s nothing to download or unpack by hand:
wget https://callflowstudio.io/install.sh
sudo bash install.sh
To read the script before running it as root, view it with less install.sh after the download. It’s a plain shell script, and q quits the viewer:
wget https://callflowstudio.io/install.sh
less install.sh
sudo bash install.sh
What the installer does
- Auto-detects your PBX (FreePBX, VitalPBX, or a fork).
- Installs alongside your PBX rather than as a FreePBX module, so Call Flow Studio won’t appear in Module Admin. FreePBX module updates leave it untouched.
- Creates the
cfstudiodatabase alongside your existingasteriskDB, so its own tables live separately from your PBX’s. When you edit a dial plan, Call Flow Studio doesn’t write SQL into theasteriskdatabase itself. It calls FreePBX’s own module functions, the same code the FreePBX admin screens use to save that IVR, queue, or ring group. - Sets up
/etc/cfstudio/with restricted permissions, for its own configuration. - On FreePBX: adds a small Apache config for
/cfstudio/and checks it before applying. On VitalPBX 4 it adds a short rule that keeps its own installer files from being served; VitalPBX’s site config isn’t edited. - Prints a one-time setup URL for the welcome flow.
It stays in its own lane: it does not change your call routing or your PBX software. It installs alongside them and reads your existing configuration to draw it. Every file, login and scheduled job it adds is listed in What it installs, and everything the PBX sends us is in the FAQ.
The compatibility checks
The installer checks your environment before it changes anything. If something is a genuine blocker (PHP < 5.6, no MariaDB/MySQL, no Asterisk, an unsupported platform, or no network to download the release), it stops at that first problem, tells you exactly what failed and why, and nothing has been installed or altered. If it spots something merely unfamiliar rather than blocking (a newer database version it hasn’t been tested against, say), it flags it and continues.
When a check stops the install, it leaves a plain-text diagnostic, and where depends on which check it was. The first ones (PHP, the database, Asterisk) are made by the install.sh you downloaded, which writes /tmp/cfs-install-<time>-XXXXXX.log; that one includes your hostname and OS. A check further in writes /var/log/cfstudio/install-error-<time>.log (in /tmp if that folder can’t be made), with versions, your detected PBX type and the failing step. Neither holds credentials, and nothing in them is sent anywhere automatically. You can read either before emailing it to support@callflowstudio.io.
Re-running & scripted rollouts
The installer is idempotent: safe to re-run. If a download is interrupted or your SSH session drops, just run it again; existing admin credentials, license keys, and your call-flow data are preserved. That also makes it safe to drive from a configuration-management run across a fleet.
Finishing in the browser
Open the URL the installer prints (it ends in ?setup_token=<random>; the token is long, so copy the whole line). The welcome flow asks for a username, email, password, and EULA acceptance. Submit, and your 30-day trial registers automatically. Call Flow Studio is then served from /cfstudio/ on the PBX.
If the welcome page won’t load, re-check the printed URL. If trial registration doesn’t go through, your admin account still exists. Log in normally and retry from Admin → License. Next: Licensing & activation.
What’s collected at registration
From the welcome form: business email, name, optional company, and your acceptance of the terms (the date and the terms version). From the PBX itself:
- Machine fingerprint: a one-way identifier for this server, used only to bind your license to one PBX. It can’t be reversed.
- Hostname, PBX brand + version, OS distribution, CFS version, PHP version, and on VitalPBX the number of tenants.
- Public IP at registration, geolocated to country / region / city.
- The admin username you chose, sent only so the welcome email can name it. We don’t keep it.
Registration is one of several times the PBX contacts us. The license check also runs every night and when someone signs in, and there are update checks, activation, password resets, sign-in codes, new-user emails, license release, optional feedback and an uninstall notice. What each one sends.
What is not collected: phone numbers, DIDs, caller IDs, call recordings, voicemail content, dial-plan content, queue or extension lists, any caller PII. Your dial plan stays on your PBX. Full inventory and handling: Privacy Policy. License terms: Terms of Service.
Uninstalling
sudo bash /usr/local/lib/cfstudio/uninstall.sh
That’s root’s own copy, on FreePBX and VitalPBX alike. Before 1.3.1 there was none: run the one in the web folder, /var/www/html/cfstudio/uninstall.sh on FreePBX or /usr/share/vitalpbx/www/cfstudio/uninstall.sh on VitalPBX. From 1.3.2 the web folder’s copy refuses to run, since the web server’s user can change files there.
Removes everything the installer added (the full list), including the install tree, /etc/cfstudio/, the cfstudio database and the Apache snippet on FreePBX. It does not touch your asterisk database or Asterisk itself, and it leaves the log files in /var/log/cfstudio/ in place, plus a backup of the cfstudio database and /etc/cfstudio/ in a /root/cfstudio-uninstall-<time> folder.
If this PBX holds a paid license, the uninstaller offers to release it so you can move it to another PBX. You can also run cfs release-license yourself first. See moving a license.