Licensing
Requirements
To enable Botpress pro features, you need to create a Botpress account, customize & buy your license and finally activate it on your Botpress Server installation. Everything you need to know is in this guide, we'll walk you to the process step by step.
Before we move on, make sure to have the followings :
- A working Botpress installation running on pro
- Admin rights on your Botpress installation (if downloaded & started Botpress you're good to go)
- A connection to the Internet
- A valid credit card
Note: There is a Botpress is currently not licensed red band, this is totally normal since you're running on pro without having a license.
Purchase a license
Create Botpress account
In order to buy a pro license, you need to create an account on our botpress licensing server (different from the account you created to access your botpress installation). To do so, open your Botpress admin and go to My Account in your user top right menu.
Go on the My Botpress Account tab and click on Login to Botpress. There you'll end up on a login/register screen make sure to click on Create an account if you don't have any yet. Fill the form and hit Register. Check your mails, a verification email will be sent shortly.
Customize your license
Now that we have a Botpress account setup, we can buy license. Go ahead an click on Buy your first key. You can fill your license a friendly name to make it easy to recognize which license is used where. By default, only the Botpress pro license is enabled which allows you to:
- Create unlimited bots
- Add collaborators
- Define and assign custom roles and permissions to your collaborators
Note that all bots will run on a single instance, where you might end up with a scalability issue when your bot hit a certain messages / sec threshold. To address this problem, we allow our clients to scale their Botpress installation to multiple nodes. You can add as many additional Nodes to your license as you need.
Don't worry, you don't have to plan everything in advance, you can always change your plan later on. If you feel like you need additional support from the Botpress team, you can check the Gold support. Go ahead and complete the checkout form! If all is fine, you should end up with a screen like the following :
Activate a license
Online Server
- Edit
data/global/botpress.config.json
and setpro.enabled: true
- Again in
botpress.config.json
sethttp.externalUrl
to the URL of your Botpress installation - Restart your server
- Go to admin > My Account > Botpress Licensing Account
To activate your license on your current Botpress installation, simply click on Use on this Server
in the Actions dropdown of your new license.
This will add the license key in your Botpress.config.json file and assign your current cluster fingerprint to the license on our license server. Botpress pro features should now be unlocked, your key should be marked as assigned and there should be an active label on your license list.
Offline Server
⚠️ Access to Internet is required in order to purchase a license and obtain a key. To facilitate the activation process, its recommended to run 2 Botpress installations, an online server (with Internet access) and the offline server (without Internet access). Once the activation process is done, the access to Internet is no longer required.
- On the online server, purchase your Botpress license
- On the offline server, edit
data/global/botpress.config.json
and setpro.enabled: true
- Again in
botpress.config.json
sethttp.externalUrl
to the url of your offline server - Restart your offline server
- Go to
Admin > Server > Server License
and locate your Fingerprint
- On the online server, assign the copied fingerprint to the license you purchased
- Click "Reveal License Key" and copy the license
- On the offline server, paste the license key to active it
Your license is now activated on your offline server. The access to internet is no longer required, but its always good to have a secured online instance to manage your licenses.
Cluster
Follow the license activation instructions for an online or an offline configuration on a single node.
Once the setup is complete, botpress.config.json
can be copied over to the other nodes so that you don't need to go through the activation process on each node.
Note: The cluster fingerprint, visible in Admin > Server > Server License, should be the same across all nodes.
Changing computer
If you want to use your Botpress license on another computer, use Assign fingerprint in the Actions dropdown of your license and enter the target botpress installation fingerprint.
Once it's done, you can copy the license key visible in Reveal License key and paste it in your target installation botpress.config.json
under the botpress.licenseKey
property.
Note: This won't allow you to use multiple computers with the same Botpress license. If you want to run a cluster you have to add nodes to your license. See how to customize your license.
License breach
If you happen to breach your license (e.g you try to add more nodes than allowed on your license), your bots wont work anymore until you either update your license or get back to an unbreached license state. If you don't remember the limits of your currently activated license, you can always go to the Server Settings page in your user top right menu. There you'll have all information on your current license.