Documentation
BitBeam Documentation
Comprehensive guides and documentation for the BitBeam platform.
Documentation Categories
Getting Started
Quick start guides and tutorials to get you up and running with BitBeam.
- • Introduction to BitBeam
- • Quick start guide
- • Basic concepts
Scanner & Analysis
Documentation for running website scans, reading scores, and interpreting recommendations.
- • Starting a scan
- • Understanding scores
- • Report interpretation
API Reference
REST API documentation for integrating with BitBeam services.
- • Authentication endpoints
- • Scan API
- • Dashboard metrics API
Security
Security best practices and authentication mechanisms.
- • OAuth 2.0 with PKCE
- • TLS configuration
- • RBAC guide
Architecture
Deep dive into the BitBeam architecture and system design.
- • OME orchestration overview
- • Proxy and enhancement pipeline
- • Tier system
AI Assistant
Documentation for the BitBeam AI assistant and knowledge ingestion.
- • AI assistant basics
- • Knowledge ingestion
- • Widget integration
Additional Resources
External Documentation
API Reference
BitBeam REST API documentation
Keycloak Documentation
Authentication and identity management documentation
SYSTEM_OVERVIEW.md
BitBeam architecture and component documentation