| Developers Guide

| Developers Guide

  • Docs
  • API
  • Help
  • Blog

›Getting Started

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

Installation

Getting started with Botpress is easy. We build and distribute binaries of the latest stable version and nightly builds of the Github master branch.

Download

The latest stable binaries are available for download here. Alternatively, you may find all the versions and nightly builds in our public S3 Bucket.

Installation

To install Botpress, unzip the file you download somewhere on your computer. Make sure that your computer has at least:

  • Memory (RAM): Recommended 4 GB or above.
  • Hard Drive: Recommended 64 GB of free space or above.
  • A 64 bits architecture
  • The right to read/write to the Botpress directory and subdirectories.

Starting Botpress

Executable

To start Botpress, all you have to do is double click on the bp file in the directory you extracted Botpress.

Alternatively, you can also start it from the terminal using the command:

./bp

The first time you run Botpress, the built-in modules take some time to install. Thereafter, subsequent runs will be much faster.

Once the modules are installed and loaded, you should see something similar to the screenshot below.

First Run

Commands

You may also start Botpress Server using the Command Line Interface (CLI). To see all the commands available, run ./bp --help.

CLI Start

Learn More

Here is a video tutorial to help you set up Botpress on your computer. You can slow it down a bit to follow along.

  • Setting up on Windows
  • Setting up on Mac
← IntroductionQuick Start →
  • Download
  • Installation
  • Starting Botpress
    • Executable
    • Commands
  • Learn More
| 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.