You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+36-18
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,27 @@
14
14
15
15
16
16
17
-
Conductor is a platform _originally_ created at **Netflix** to orchestrate microservices and events.
18
-
[Conductor OSS](https://conductor-oss.org) is maintained by the team of developers at [Orkes.io](https://orkes.io/) along with members of the open source community.
17
+
Conductor is a platform _originally_ created at **Netflix** to orchestrate microservices and events. [Conductor OSS](https://conductor-oss.org) is maintained by the team of developers at [Orkes.io](https://orkes.io/) along with members of the open source community.
Conductor (or [Netflix Conductor](https://netflixtechblog.com/netflix-conductor-a-microservices-orchestrator-2e8d4771bf40)) is a microservices orchestration engine for distributed and asynchronous workflows. It empowers developers to create workflows that define interactions between services, databases, and other external systems.
@@ -53,6 +61,7 @@ Conductor is designed to enable flexible, resilient, and scalable workflows. It
53
61
* Install Java (JDK) 17 or newer
54
62
* Node 14 for the UI to build
55
63
*_Earlier versions may work, but are untested_
64
+
56
65
57
66
## Quick Start Guide
58
67
@@ -82,12 +91,15 @@ docker compose -f docker/docker-compose.yaml up
82
91
##### Or use the REST API with your preferred HTTP client
83
92
*http://localhost:8080
84
93
85
-
## Database Requirements
86
-
94
+
# Documentation
95
+
Check-out the [Conductor OSS docs](https://github.com/conductor-oss/conductor/tree/main/docs) for additional details
96
+
- - -
97
+
# Database Specifications
87
98
* The default persistence used is Redis
88
99
* The indexing backend is [Elasticsearch](https://www.elastic.co/) (7.x)
@@ -97,7 +109,6 @@ docker compose -f docker/docker-compose.yaml up
97
109
| MySQL + ES7 |[config-mysql.properties](docker/server/config/config-mysql.properties)|
98
110
99
111
100
-
- - -
101
112
# Deployment Options
102
113
In addition to the Docker Compose setup, Netflix Conductor supports several other deployment methods to suit various environments:
103
114
@@ -114,19 +125,26 @@ Conductor provides several SDKs for interacting with the API and creating custom
114
125
115
126
Each SDK is maintained as part of the Conductor project, providing examples and comprehensive API documentation.
116
127
117
-
# Documentation and Community
118
-
***Official Documentation:**[Conductor documentation](https://docs.conductor-oss.org/index.html) contains detailed explanations of workflow concepts, API reference, and guides.
119
-
***Conductor Slack:**[Join the Conductor Slack](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) channel for community discussions and support.
120
-
***Orkes Community Discourse:**[Hosted by Orkes.io](https://community.orkes.io) on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas.
121
-
122
-
123
128
# Conductor OSS Roadmap
124
129
[See the roadmap for the Conductor](ROADMAP.md)
125
-
126
130
If you would like to participate in the roadmap and development, [please reach out](https://forms.gle/P2i1xHrxPQLrjzTB7).
127
131
132
+
# Documentation and Community
133
+
***Official Documentation:**[Conductor documentation](https://docs.conductor-oss.org/index.html) contains detailed explanations of workflow concepts, API reference, and guides.
134
+
***Conductor Slack:**[Join the Conductor Slack](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) channel for community discussions and support.
135
+
***Orkes Community Discourse:**[Hosted by Orkes.io](https://community.orkes.io) on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas.
-**Report Issues:** Found a bug or have a feature request? Open an [issue on GitHub](https://github.com/conductor-oss/conductor/issues).
145
+
-**Contribute Code:** Check out our [Contribution Guide](https://github.com/conductor-oss/conductor/blob/main/CONTRIBUTING.md) for initial guidelines, and explore our [good first issues](https://github.com/conductor-oss/conductor/labels/good%20first%20issue) for beginner-friendly tasks to tackle first.
146
+
-**Build a Conductor SDK:** Need an SDK not included with Conductor? Build your own using the [Swagger API](http://localhost:8080) included with your local deployment.
147
+
-**Contribute to our Docs:** Contribute edits or updates to keep our [documentation](https://github.com/conductor-oss/conductor/tree/main/docs) in great shape for the community.
0 commit comments