omnibot Logo
1.0.3-3abc74

Usage

  • Installation
    • Quickstart for testing
    • Docker installation
      • To run omnibot in Docker
      • To build the image
    • pip installation
      • Make a virtualenv and install pip requirements
    • Manual installation
      • Clone omnibot
      • Make a virtualenv and install pip requirements
      • Run omnibot
  • Configuration
    • Example Minimal Configuration
    • Basic Configuration
      • Configuration File Configuration
      • Teams
      • Bots
      • Bot Credential Configuration
      • URLs Configuration for Use in Slack App Dashboard
      • SQS Configuration
      • Redis Configuration
      • Statsd Configuration
      • Logging Configuration
    • Handler Configuration
      • Common Handler Configuration
      • Message Handlers
      • Interactive Component Handlers
      • Slash Command Handlers
    • API Access Control Configuration
  • Adding new slack apps
    • Adding normal slack apps
    • Adding a slack app for use as a primary bot
  • Observability
    • Stats
      • Delivery and Processing
      • Webhook Worker Gevent Pool
      • Watcher Worker Latency
    • Logs
      • Event Subscription Tracing Data
      • Slash Command Tracing Data
      • Interactive Component Tracing Data

Development

  • Quickstart and Development
    • Prerequisites
    • Quickstart
      • Developing new bots
      • Making and testing changes to omnibot using docker and docker-compose
  • Omnibot receiver libraries
    • Python
  • Event parsing
    • Event Subscription Events
      • Message Events
    • Interactive Component Events
    • Slash Command Events
  • Slack proxying
    • Message handlers
    • Slash command and interactive component handlers
  • Writing new callback functions
  • Contributing
    • Code of conduct
    • Contributing code
      • Sign the Contributor License Agreement (CLA)
      • File issues in Github
      • Submit pull requests
      • Adding new dependencies to requirements
      • Approving licenses or dependencies

API endpoint

  • API
    • API route documentation

Python module documentation

  • omnibot package
    • Subpackages
      • omnibot.authnz package
        • Submodules
        • omnibot.authnz.envoy_checks module
        • Module contents
      • omnibot.callbacks package
        • Submodules
        • omnibot.callbacks.interactive_component_callbacks module
        • omnibot.callbacks.message_callbacks module
        • omnibot.callbacks.network_callbacks module
        • omnibot.callbacks.slash_command_callbacks module
        • Module contents
      • omnibot.routes package
        • Submodules
        • omnibot.routes.api module
        • Module contents
      • omnibot.scripts package
        • Submodules
        • omnibot.scripts.omniredis module
        • omnibot.scripts.utils module
        • Module contents
      • omnibot.services package
        • Subpackages
        • Submodules
        • omnibot.services.omniredis module
        • omnibot.services.sqs module
        • omnibot.services.stats module
        • Module contents
      • omnibot.utils package
        • Submodules
        • omnibot.utils.settings module
        • Module contents
    • Submodules
    • omnibot.app module
    • omnibot.processor module
    • omnibot.settings module
    • omnibot.setup_logging module
    • omnibot.watcher module
    • omnibot.webhook_worker module
    • omnibot.wsgi module
    • Module contents
omnibot
  • Docs »
  • Search

© Copyright 2019-2022, Omnibot Project Authors

Built with Sphinx using a theme provided by Read the Docs.