How-To Guides
Welcome to the RunReveal How-To Guides section. Here you'll find step-by-step instructions for common tasks and use cases to help you get the most out of RunReveal.
Available Guides
Onboarding Guide
Complete step-by-step guide for getting started with RunReveal's security data platform. Read the guide →
- Account setup and workspace configuration
- Connecting your first data sources
- Creating detections and configuring alerts
- Exploring platform features and AI Chat
- Setting up dashboards and CLI tools
Quick Start: Detections, Signals, and Alerts
Learn the fundamentals of RunReveal's detection system with hands-on examples. Read the guide →
- Creating webhook sources for test data
- Building SQL-based detection rules
- Understanding signals vs alerts
- Setting up notification workflows
Collecting Nginx Logs
Learn how to use Reveald, our efficient log collection daemon, to collect and process Nginx logs for visualization in RunReveal. Read the guide →
- Installation and configuration of Reveald
- Setting up a structured webhook source in RunReveal
- Configuring Nginx to forward logs to Reveald
- Viewing and analyzing your Nginx logs in RunReveal
Kubernetes Logs
Configure log collection from Kubernetes clusters using Reveald as a daemonset. Read the guide →
- Setting up Reveald as a Kubernetes daemonset
- Configuring Reveald to collect pod logs
- Forwarding logs to RunReveal
- Best practices for Kubernetes log collection
OpenAPI Specification
Retrieve and use RunReveal's OpenAPI 3.0 spec for API integration, client generation, or importing into tools like Postman. Read the guide →
- Generating the spec via the RunReveal CLI
- Fetching the spec from the API endpoint
- Using the spec with API tools and code generators
Need More Help?
If you need assistance with implementation or have questions about collecting logs from other sources, please reach out through:
- Your shared Slack channel (if applicable)
- Email us at [email protected]