Administration Guide

This guide covers the configuration and administration of Crossbar.io.

Concepts

• Basic Concepts
  • WAMP
  • Crossbar.io Node
  • Configuration
  • Installation

Node Configuration

• Node Configuration
  • Configuration File Location
  • Configuration File Format
  • Checking a Configuration
• IoT Microservice Weather Balloon example using Container Component with Dynamic Authentication
  • Disambiguation: containers discussed here are not related to Docker Containers
  • Why container components are useful: eg. microservices and cloud control of remote devices
  • But first, authentication vs authorization: a refresher
  • config.json
  • authenticator.py
  • balloon.py
  • index.html
• Processes
  • Configuration
• Controller Configuration

Router Configuration

• Router Configuration
  • Configuration
• Router Realms
  • Configuring Realms on a Router
  • Realm Options
• Router Components
• Proxy-Workers

Worker Configuration

• Container Configuration
  • Failures
  • Configuration
• Guest Configuration
  • Configuration
• Native Worker Options
• Process Environments

Transports

• Router Transports
  • Background
• Transport Endpoints
  • TCP Endpoints
  • Unix Domain Sockets
  • Tor Services
• WebSocket Transport
  • Configuration
  • Example
• WebSocket Options
  • Available Options
  • Production Settings
• WebSocket Compression
  • Activating Compression
  • Compression Options
  • Production Settings
• RawSocket Transport
  • Configuration
  • Example
• Flash Policy Transport
  • Configuration
  • Usage
  • Configuration
• Web Transport and Services
  • Configuration
  • Example

Web Services

• Web Services
• Static Web Service
  • Configuration
  • Example - Serving from Directories
  • Example - Serving from Python Packages
• Web Redirection Service
  • Configuration
  • Example
• JSON Value Service
  • Configuration
  • Example
• Node Info Service
  • Configuration
  • Example
• CGI Script Service
  • Configuration
  • Example
• WSGI Host Service
  • Configuration
  • Example
• Reverse Proxy Service
  • Configuration
  • Example
• WebSocket Service
  • Configuration
  • Example
• Long-poll Service
  • Configuration
  • Test using curl
  • Use with AutobahnJS
  • Use with AutobahnPostgres
• Path Service
  • Configuration
  • Example
• Resource Service
  • Configuration
  • Example
• File Upload Service
  • Configuration
  • File Post processing
  • Resumable Uploads
  • Example
• Web Archives
  • Configuration
  • Example

HTTP Bridge

• HTTP Bridge
  • Quick Links
  • Background
• HTTP Bridge Publisher
  • Introduction
  • Try it
  • Using Python
  • Configuration
  • Running Standalone
  • PHP - Symfony Publisher Bundle
• HTTP Bridge Subscriber
  • Introduction
  • Try it
  • Configuration
  • Handling Forwarded Events
• HTTP Bridge Caller
  • Introduction
  • Try it
  • Configuration
  • Making Requests
• HTTP Bridge Callee
  • Try it
  • Configuration
  • Examples
• HTTP Bridge Webhook
  • Introduction
  • Try it
  • Configuration
  • With GitHub

Authentication

• Authentication
  • Introduction
  • Session vs Transport Level
  • Shared Secret vs. Public Key
  • Static, Dynamic and Database Authentication
  • Authentication Per Transport
• Anonymous Authentication
  • Dynamic authentication
• Ticket Authentication
  • Static
  • Dynamic
  • TOTP authentication
• Challenge-Response Authentication
  • Introduction
  • Authenticating Components
  • Static Credentials
  • Dynamic Credentials
  • Examples
  • Configuration
• SCRAM Authentication
• Cryptosign Authentication
  • Cryptosign Configuration
• Cookie Authentication
  • Introduction
  • Configuration
• TLS Client Certificate authentication
  • Static
  • Dynamic
• Dynamic Authenticators
  • Running authenticators in configurable realms
  • Data the authenticator can set
  • Example

Authorization

• Authorization
  • Introduction
  • Authorization Procedure
  • Static Authorization
  • Dynamic Authorization
  • Example

Security

• Secure WebSocket and HTTPS
  • WebSocket Transport Configuration
  • Endpoint TLS Configuration
  • TLS Certificates
  • Examples
  • Resources
• TLS Certificates
  • Using Self-signed Certificates
  • Using commercial certificates
  • Creating your own Certificate Authority
  • Testing
  • Using Lets Encrypt with Crossbar.io
  • Tracking down issues
• Updating Certificates
  • Updating LetsEncrypt with certbot
• SSL/TLS Interception Proxies
  • Products
• Cookie Tracking
  • How it works
  • Cookie Tracking without Authentication
  • Cookie Tracking with Authentication
  • Configuration
  • Examples

MQTT

• MQTT Broker and Bridge
  • Payload Mapping
  • Examples
  • Configuration

Operations

• The Command Line
  • Quick Reference
  • Getting Help
  • Initializing a Node
  • Starting and Stopping a Node
• Logging
  • Formats
  • Levels
  • Logging to a file
  • Adding logging to your components
• Going to Production
• Automatic Startup and Restart
  • systemd
  • upstart
  • daemontools
• Running on Privileged Ports
  • Linux
  • FreeBSD
• Scaling Crossbar.io
  • Scaling Application Components
  • Scaling Routers
• Network Tuning
  • Linux
  • FreeBSD
• Reverse Proxies
  • HAProxy
  • Nginx
  • Apache

Deployment

• Installation on Linux
  • Prepare
  • Install for CPython
  • Install for PyPy
  • Updating to newest release
  • Updating to current develepment version
  • Update Crossbar.io
• Installation on Mac OS X
  • Setting up CPython
  • Setting up PyPy
  • Installing Crossbar.io
• Installation on Windows
  • Basic Installation
  • Installation from Source
  • Running Crossbar.io from the Git shell
• Creating Docker Images
  • Create new image with node directory embedded
• Setup on Amazon EC2
  • Create an Instance
  • SSH into the instance
  • Updating Crossbar.io
• Setup on Heroku
  • Application Setup
  • Crossbar.io configuration
• Setup on OpenShift
  • Pre-requisites
  • Crossbar.io on OpenShift
  • Use a a base application to start with
  • Crossbar.io configuration
  • What will you get