# Osmedeus Docs

## Docs

- [Extra Configuration](https://docs.osmedeus.org/advanced/api-key-configuration.md): Multiple ways to install Osmedeus
- [Deployment](https://docs.osmedeus.org/advanced/deployment.md): Build, deploy, and run Osmedeus in various environments
- [Development](https://docs.osmedeus.org/advanced/development.md): Development and hacking on Osmedeus
- [Distributed Execution](https://docs.osmedeus.org/advanced/distributed.md)
- [Event-Driven Triggers](https://docs.osmedeus.org/advanced/event-driven.md): Build reactive automation pipelines with event-driven workflows
- [Using Osmedeus as a Library](https://docs.osmedeus.org/advanced/library.md): Embed Osmedeus workflow engine in your Go applications
- [LLM & Agents Integration](https://docs.osmedeus.org/advanced/llm.md)
- [Notification and CDN Configuration](https://docs.osmedeus.org/advanced/notification-and-cdn.md): This guide covers advanced configuration options including notification and CDN setup
- [Scheduling & Queue](https://docs.osmedeus.org/advanced/scheduling.md)
- [Snapshots](https://docs.osmedeus.org/advanced/snapshots.md)
- [Writing Your First Workflow](https://docs.osmedeus.org/advanced/writing-your-first-workflow.md): YAML-based workflow definitions and execution
- [Osmedeus API Documentation](https://docs.osmedeus.org/api-references/index.md): RESTful API reference for managing security automation workflows
- [Architecture Overview](https://docs.osmedeus.org/architecture/index.md): Technical architecture overview of the Osmedeus workflow engine
- [Runners](https://docs.osmedeus.org/architecture/runners.md): Execution environments for commands and steps
- [Template Engine Architecture](https://docs.osmedeus.org/architecture/templates.md): Deep dive into the Osmedeus template engine implementation
- [Workflow Architecture](https://docs.osmedeus.org/architecture/workflows.md): Deep dive into the Osmedeus workflow system including fragments and linting
- [Cloud Cheatsheet](https://docs.osmedeus.org/cloud/cheatsheet.md): Quick cheatsheet for cloud setup, workflow mode, custom commands, and infrastructure management
- [AWS Provider Guide](https://docs.osmedeus.org/cloud/provider-aws.md): Step-by-step guide for running osmedeus cloud on AWS EC2 instances
- [GCP Provider Guide](https://docs.osmedeus.org/cloud/provider-gcp.md): Step-by-step guide for running osmedeus cloud on Google Cloud Platform Compute Engine instances
- [Hetzner Provider Guide](https://docs.osmedeus.org/cloud/provider-hetzner.md): Step-by-step guide for running osmedeus cloud on Hetzner Cloud servers, the lowest cost provider
- [Cloud Quick Reference](https://docs.osmedeus.org/cloud/quick-reference.md): Quick reference for cloud configuration, infrastructure management, and command flags
- [Cloud Usage Examples](https://docs.osmedeus.org/cloud/usage-examples.md): Practical examples for running distributed security scans and custom commands on cloud infrastructure
- [Cloud Usage Guide](https://docs.osmedeus.org/cloud/usage-guide.md): Provision cloud infrastructure and run security workflows or arbitrary commands on cloud VMs
- [Adding CLI Commands](https://docs.osmedeus.org/extending/cli-commands.md)
- [Adding Functions](https://docs.osmedeus.org/extending/functions.md)
- [Adding Runners](https://docs.osmedeus.org/extending/runners.md)
- [Adding Step Types](https://docs.osmedeus.org/extending/step-types.md)
- [Functions Overview](https://docs.osmedeus.org/functions/overview.md)
- [Functions Reference](https://docs.osmedeus.org/functions/reference.md)
- [Basic Configuration](https://docs.osmedeus.org/getting-started/basic-setup.md): Osmedeus configuration management and settings
- [CLI Interface](https://docs.osmedeus.org/getting-started/cli.md): Command-line interface for Osmedeus
- [Docker Installation & Setup](https://docs.osmedeus.org/getting-started/docker-setup.md): Containerized Setup and Execution Using Docker
- [Web UI](https://docs.osmedeus.org/getting-started/web-ui.md): Server and Web UI for Osmedeus
- [Introduction](https://docs.osmedeus.org/index.md): Welcome to the Osmedeus Documentation
- [FAQs](https://docs.osmedeus.org/others/faq.md): FAQs and Common Errors
- [Premium Edition](https://docs.osmedeus.org/others/premium-edition.md): Exclusive features and benefits available in the Osmedeus Premium Edition
- [Security Warning](https://docs.osmedeus.org/others/security-warning.md): Important Security Notice and Disclaimer
- [Quickstart](https://docs.osmedeus.org/quickstart.md): Get up and running with Osmedeus in 5 minutes
- [Type Reference](https://docs.osmedeus.org/reference/types.md): Complete reference for all type constants used in Osmedeus workflows
- [Default Variables Reference](https://docs.osmedeus.org/reference/variables.md): Complete reference for template variables and utility functions in Osmedeus
- [Workflow Schema Reference](https://docs.osmedeus.org/reference/workflow-schema.md): Complete YAML schema reference for Osmedeus workflows
- [Control Flow](https://docs.osmedeus.org/workflows/control-flow.md): Conditions, routing, and error handling
- [Flow Workflows](https://docs.osmedeus.org/workflows/flows.md): Multi-module orchestration with dependencies
- [Workflow Overview](https://docs.osmedeus.org/workflows/overview.md): Introduction to workflow structure and concepts
- [Step Types](https://docs.osmedeus.org/workflows/step-types.md): Available step types for workflow execution
- [Variables and Exports](https://docs.osmedeus.org/workflows/variables.md): Data flow and parameter management

## Optional

- [Contact](https://x.com/j3ssie)