Overview
Implements a complete connector for Outline, a collaborative knowledge base platform. Supports both self-hosted and cloud-hosted instances with full indexing of Collections and Documents.
Key Features
- ✅ Load and Poll connector interfaces for full and incremental indexing
- ✅ RPC-style API client with Bearer token authentication
- ✅ Comprehensive error handling and rate limiting
- ✅ Full frontend integration with custom icon and UI forms
- ✅ Extensive test suite (unit, integration)
Configuration
Users provide:
- Base URL: Outline instance URL (e.g.,
https://company.getoutline.com
)
- API Token: Valid API token with read permissions
Testing
Integration tests require environment variables:
export OUTLINE_BASE_URL="https://your-outline-instance.com"
export OUTLINE_API_TOKEN="your-api-token-here"
pytest tests/daily/connectors/outline/test_outline_basic.py
Getting API Credentials
- Outline instance → Preferences → API & Apps
- Create new API token
- Ensure read permissions (collections.list, documents.list)
Quality Assurance
- All linting/formatting checks pass (ruff, black, mypy)
- Follows existing connector patterns (BookStack-style)
- Full TypeScript integration
- Comprehensive test coverage
Demo
outline-connector.webm
Documentation
Related Issues
/fix #3256
/claim #3256
Summary by cubic
Added a new connector for Outline knowledge base, supporting both self-hosted and cloud-hosted instances with full indexing and incremental polling of collections and documents.
- New Features
- Outline connector with API client, error handling, and validation.
- Frontend integration with custom icon, credential forms, and Wiki categorization.
- Full test suite for connector and API client.