StreamSpace Plugins

Overview

Repository Structure

streamspace-plugins/
├── streamspace-slack/ # Slack integration plugin
├── streamspace-teams/ # Microsoft Teams plugin
├── streamspace-discord/ # Discord integration plugin
├── streamspace-pagerduty/ # PagerDuty integration plugin
├── streamspace-email/ # SMTP email plugin
├── streamspace-calendar/ # Calendar integration plugin
├── streamspace-datadog/ # Datadog monitoring plugin
├── streamspace-newrelic/ # New Relic monitoring plugin
├── streamspace-sentry/ # Sentry error tracking plugin
├── streamspace-elastic-apm/ # Elastic APM plugin
├── streamspace-honeycomb/ # Honeycomb observability plugin
├── streamspace-compliance/ # Compliance framework plugin
├── streamspace-dlp/ # Data loss prevention plugin
├── streamspace-audit-advanced/ # Advanced audit logging plugin
├── streamspace-recording/ # Session recording plugin
├── streamspace-snapshots/ # Session snapshots plugin
├── streamspace-multi-monitor/ # Multi-monitor support plugin
├── streamspace-workflows/ # Workflow automation plugin
├── streamspace-analytics-advanced/ # Advanced analytics plugin
├── streamspace-auth-saml/ # SAML authentication plugin
├── streamspace-auth-oauth/ # OAuth/OIDC authentication plugin
├── streamspace-storage-s3/ # S3 storage backend plugin
├── streamspace-storage-azure/ # Azure storage backend plugin
├── streamspace-storage-gcs/ # Google Cloud Storage plugin
├── streamspace-billing/ # Billing & usage tracking plugin
├── streamspace-node-manager/ # Kubernetes node manager plugin
├── catalog.yaml # Plugin discovery metadata
├── claude.md # AI context documentation
├── README.md # This file
└── CONTRIBUTING.md # Contribution guidelines

Plugin Categories

Official Plugins

Community Plugins

Usage

Runtime Packaging

./scripts/package_plugins.sh

dist/
├── catalog.yaml
└── streamspace-slack/
 ├── manifest.json
 ├── streamspace-slack.so
 ├── plugin.tar.gz
 └── README.md

Install from Catalog

# In Helm values.yaml
repositories:
 plugins:
 enabled: true
 url: https://github.com/JoshuaAFerguson/streamspace-plugins
 branch: main
 syncInterval: "1h"

Install Individual Plugin

# Using StreamSpace CLI
streamspace plugin install streamspace-recording
# Or manually
kubectl apply -f https://raw.githubusercontent.com/JoshuaAFerguson/streamspace-plugins/main/streamspace-recording/manifest.yaml

List Available Plugins

# Via API
curl https://streamspace.local/api/plugins/catalog
# Or view catalog.yaml
curl https://raw.githubusercontent.com/JoshuaAFerguson/streamspace-plugins/main/catalog.yaml

Plugin Types

1. Extension Plugins

2. Webhook Plugins

3. API Integration Plugins

4. UI Theme Plugins

Plugin Structure

my-plugin/
├── manifest.json # Plugin metadata (required)
├── index.js # Entry point (required)
├── README.md # Documentation (required)
├── config.schema.json # Configuration schema (optional)
├── package.json # Node.js dependencies (if needed)
└── assets/ # Images, icons, etc.
 └── icon.png

Minimal manifest.json

{
 "name": "my-plugin",
 "version": "1.0.0",
 "displayName": "My Plugin",
 "description": "Brief description",
 "type": "extension",
 "author": "Your Name",
 "license": "MIT",
 "permissions": ["read:sessions"],
 "entrypoints": {
 "main": "index.js"
 }
}

Minimal index.js

module.exports = {
 async onLoad() {
 console.log('Plugin loaded!');
 },
 async onUnload() {
 console.log('Plugin unloaded!');
 }
};

Quick Start

1. Create a New Plugin

# Clone this repository
git clone https://github.com/JoshuaAFerguson/streamspace-plugins.git
cd streamspace-plugins
# Create plugin directory
mkdir streamspace-my-plugin
cd streamspace-my-plugin
# Initialize
npm init -y
# Create manifest
cat > manifest.json <<EOF
{
 "name": "my-plugin",
 "version": "1.0.0",
 "displayName": "My Plugin",
 "description": "My custom StreamSpace plugin",
 "type": "extension",
 "author": "Your Name",
 "license": "MIT",
 "permissions": ["read:sessions"],
 "entrypoints": {
 "main": "index.js"
 }
}
EOF
# Create entry point
cat > index.js <<EOF
module.exports = {
 async onLoad() {
 console.log('My plugin loaded!');
 }
};
EOF

2. Test Your Plugin

# Package plugin
tar -czf my-plugin.tar.gz manifest.json index.js
# Upload to StreamSpace
curl -X POST https://streamspace.local/api/plugins/upload \
 -H "Authorization: Bearer $TOKEN" \
 -F "file=@my-plugin.tar.gz"
# Enable plugin
curl -X POST https://streamspace.local/api/plugins/my-plugin/enable \
 -H "Authorization: Bearer $TOKEN"

3. Submit for Inclusion

API Reference

module.exports = {
 async onLoad({ api, config }) {
 // List sessions
 const sessions = await api.sessions.list();
 // Get user info
 const user = await api.users.get('username');
 // Access plugin config
 const setting = config.get('mySetting');
 // Register webhook
 api.webhooks.on('session.created', async (event) => {
 console.log('New session:', event.data.session);
 });
 }
};

Available API Modules

Permissions

Security

Examples

Webhook Plugin - Slack Notifications

// streamspace-slack/index.js
module.exports = {
 async onLoad({ api, config }) {
 const webhookUrl = config.get('slackWebhookUrl');
 api.webhooks.on('session.created', async (event) => {
 await fetch(webhookUrl, {
 method: 'POST',
 headers: { 'Content-Type': 'application/json' },
 body: JSON.stringify({
 text: `New session created: ${event.data.session.name}`
 })
 });
 });
 }
};

Extension Plugin - Custom Dashboard Widget

// community/custom-widget/index.js
module.exports = {
 async onLoad({ api, ui }) {
 ui.registerWidget({
 id: 'my-widget',
 title: 'My Custom Widget',
 component: 'MyWidget.vue',
 location: 'dashboard'
 });
 }
};

Support

License

Links