GeneralBots/botbook
2
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
botbook/src/chapter-01
History
Rodrigo Rodriguez (Pragmatismo) 2110995b7f Refactor: CRM automations, monitoring homepage, webhook examples, docs standards 
- Environment Variables: Simplified to ONLY VAULT_* vars, everything else in config.csv
- Attendant Module: Added CRM automations (follow-ups, collections/cobranças, scheduling/agendamentos, sales/vendas)
- NEW: Hosting, DNS, MDA integration docs (Namecheap, Stalwart, LLM providers)
- Monitoring: Updated as live operations homepage with real data endpoints
- Examples: Renamed to 'Webhook Integrations and Jobs', removed loop-based examples 1 & 5, added lead nurturing, payment collection, appointment scheduling
- Documentation Standards: WhatsApp HTML style as canonical conversation format, SVG for interfaces
- Reading Flow: Improved Executive Vision → Quick Start → Chapter 01 transitions with navigation tables
2025-12-03 21:59:49 -03:00
..
assets - Split from botserver. 2025-12-03 19:56:35 -03:00
first-conversation.md - Split from botserver. 2025-12-03 19:56:35 -03:00
installation.md - Split from botserver. 2025-12-03 19:56:35 -03:00
overview.md - Split from botserver. 2025-12-03 19:56:35 -03:00
quick-start.md - Split from botserver. 2025-12-03 19:56:35 -03:00
README.md Refactor: CRM automations, monitoring homepage, webhook examples, docs standards 2025-12-03 21:59:49 -03:00
sessions.md - Split from botserver. 2025-12-03 19:56:35 -03:00

README.md

Chapter 01: Run and Talk

⚡ In a hurry? Jump straight to Quick Start — you'll be chatting with your bot in 5 minutes.

Get General Bots running and have your first conversation.

What You'll Achieve

By the end of this chapter, you will:

  • ✅ Have General Bots running on your machine
  • ✅ Understand what happens during bootstrap
  • ✅ Complete your first conversation with a bot
  • ✅ Know how sessions and channels work

Choose Your Path

If You Want To... Go To
Get running immediately Quick Start
Understand the architecture first Overview
See all installation options Installation
Learn about conversations First Conversation
Understand session management Sessions and Channels

The 30-Second Version

./botserver

Open http://localhost:8080. Start chatting. That's it.

Everything installs automatically on first run—PostgreSQL, storage, cache, and your first bot.

How It Works

How do I get started with General Bots?

09:00

Just three steps:

1️⃣ Download botserver

2️⃣ Run ./botserver

3️⃣ Open your browser to localhost:8080

The bootstrap process handles everything else automatically!

09:00

What gets installed?

09:01

📦 PostgreSQL (database)

📦 MinIO (file storage)

📦 Cache (Redis-compatible)

📦 Default bot templates

All in botserver-stack/ — no system-wide installation!

09:01

Topics in This Chapter

Overview

What General Bots does and how it fits together.

Quick Start

The fastest path from zero to running bot.

Installation

Detailed setup options including LXC containers and production deployment.

First Conversation

Understanding how the bot responds and learns.

Sessions and Channels

How conversations are managed across WhatsApp, Web, Telegram, and more.

Coming From Executive Vision?

If you just read the Executive Vision, here's what to know:

  1. Everything in that feature table? It's all included in the single botserver binary
  2. No configuration needed — Bootstrap detects your system and sets everything up
  3. Start simple — Run it, chat with it, then customize

The philosophy is: get running first, understand later.

Prerequisites

  • Operating System: Linux, macOS, or Windows (WSL2 recommended)
  • Disk Space: ~2GB for botserver-stack
  • RAM: 4GB minimum, 8GB recommended
  • Ports: 8080 (web), 5432 (database), 9000 (storage)

No Docker required. No cloud accounts. No API keys to start.

Next Step

Quick Start →

General Bots