| Developers Guide

| Developers Guide

  • Docs
  • API
  • Help
  • Blog

›Pro Edition

Notes on Versions Released

  • Migrating & Updating
  • Updating to New Releases

Getting Started

  • Introduction
  • Installation
  • Quick Start

Main Concepts

  • Overview
  • Glossary
  • CMS
  • Dialog Engine
  • Actions & Hooks
  • Memory
  • Modules
  • NLU
  • Emulator

Advanced Guides

  • Debug
  • Configuration
  • Authentication Methods
  • Custom Module
  • Performances
  • Hosting
  • Version Control
  • Development Pipelines
  • Clustering

Channels

  • Website Embedding
  • Facebook Messenger
  • Telegram
  • Microsoft Teams
  • Converse API
  • Slack
  • Smooch (Sunshine Conversations)
  • FAQ

Tutorials

  • Deploying a cluster on Digital Ocean
  • How to act on an intent
  • Acting Proactively
  • Using Carousel Postback
  • How to use Slot Skill
  • How to use Call API Skill
  • Calling an API in a Custom Action
  • Shortlinks
  • Connecting your bot with your existing backend
  • Supported databases
  • Timeouts
  • Human in the loop
  • Jump To
  • Inter-bot Communication / Delegation
  • Contextual FAQ
  • Authenticate a user against a 3rd Party OAuth
  • Listening for file changes
  • Using a 3rd party NLU
  • Using the UiPath integration for Botpress

Pro Edition

  • About
  • Licensing
  • Configuring RBAC
  • Monitoring & Alerting
  • Bot Pipelines
  • Internationalization

Licensing

Obtaining a License

Please contact our sales team using the request demo form on our website.

Activate your License

When starting Botpress, use the BP_LICENSE_KEY=<license_key> environment variable as well as the EXTERNAL_URL=<public_url> environment variable.

Binary

BP_LICENSE_KEY=<license_key> EXTERNAL_URL=<public_url> ./bp

Docker

docker run -d \
--name botpress \
-p 3000:3000 \
-v botpress_data:/botpress/data \
-e BP_LICENSE_KEY=<license_key> \
-e EXTERNAL_URL=<public_url> \
botpress/server:$TAG

License Breach and Details

If you happen to breach your license (e.g you try to add more nodes than allowed on your license), your bots won't 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.

BP license keys active

← AboutConfiguring RBAC →
  • Obtaining a License
  • Activate your License
  • License Breach and Details
| Developers Guide
Docs
Getting Started (or other categories)Guides (or other categories)API Reference (or other categories)
Community
User ShowcaseStack OverflowProject ChatTwitter
More
BlogGitHubStar
Facebook Open Source
Copyright © 2021 Botpress Inc.