Install adds a small cfs command to the PBX (at /usr/sbin/cfs, alongside fwconsole and asterisk). Run it as root. Day to day, cfs upgrade is the one you’ll use; the rest are for rare situations.
cfs: command not found? The shortcut wasn’t created on your box — run the same commands as sudo php /var/www/html/cfstudio/bin/cfs <command> instead. Everything below works identically.
cfs upgrade
Upgrades Call Flow Studio in place to the current release. It shows the current and latest version and asks before changing anything; your settings, views, and license are preserved. If you’re already up to date it does nothing. This is the normal way to stay current.
sudo cfs upgrade| Exit | Meaning |
|---|---|
| 0 | Upgraded successfully |
| 2 | Bad arguments, or not run as root |
| 3 | Couldn’t fetch the release manifest |
| 4 | Download failed |
| 5 | Checksum mismatch (download rejected) |
| 6 | Couldn’t unpack the archive |
| 7 | The install step failed |
cfs release-license
Only needed when you’re moving a paid license to different hardware. It frees this PBX’s license: it confirms with you, tells the licensing server to unbind this machine, clears the local key, and drops this box to viewer mode. Then activate the same code on the new PBX.
sudo cfs release-licenseTrials aren’t bound to hardware, so this doesn’t apply to them.
| Exit | Meaning |
|---|---|
| 0 | Released successfully |
| 1 | General error (e.g. network/server) |
| 2 | Bad arguments |
| 3 | No license file, or it’s unreadable |
| 4 | This is a trial — nothing to release |
| 5 | License is revoked |
| 6 | You declined the confirmation |
Reset the admin password
Locked out of the admin login? Reset it from the PBX shell:
sudo php /var/www/html/cfstudio/api/cfs-reset-password.php admin --randomThis prints a new temporary password and forces a change at next login. Drop --random to be prompted for one instead, or pass a different email/username in place of admin.
cfs --help
Lists the available commands.