Home

Welcome to the Synapse Wiki

Synapse is a powerful, vendor-neutral, open-source Workflow Management System (WFMS) that adheres to the Serverless Workflow specification. This Wiki serves as a comprehensive resource for getting started, exploring advanced features, and contributing to the project.

Getting Started

• About Synapse: A brief overview of what Synapse is and what it offers.
• Installation Guide: Step-by-step instructions to set up Synapse on your local machine or in the cloud.
• Quick Start: A hands-on tutorial to help you create and run your first workflow.

Documentation

• Workflow Concepts: Learn about the core concepts behind workflows in Synapse, including tasks, transitions, and event handling.
• API Documentation: Detailed documentation of the Synapse API, including endpoints, request/response formats, and usage examples.
• CLI Usage: Guide on how to interact with Synapse using the command-line interface (synctl).

Advanced Topics

• Microservices: Explore the different components that make up Synapse and how they interact.
• Extending: Discover how to enhance Synapse by integrating custom services and defining custom logic through extensions, custom functions, and plugins.
• Scaling and Performance: Tips and best practices for scaling Synapse in production environments.

Contributing

• Contribution Guidelines: How to get involved with the Synapse project, including submitting issues, contributing code, and improving documentation.
• Community: Join discussions, find help, and connect with other contributors.

Community & Support

• Discussions: Engage with other users and developers, ask questions, and share your experiences.
• Code of Conduct: Understand the standards we uphold in our community interactions.

License

Synapse is licensed under the Apache 2.0 License.