From 237a47976954b43e1c7ad8faad968b9a437841c9 Mon Sep 17 00:00:00 2001 From: Viren Baraiya Date: Wed, 3 Jul 2024 00:20:36 -0700 Subject: [PATCH] update README --- README.md | 72 +++++++++++++++++++++++++------------------------------ 1 file changed, 33 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 27846faf1..5f0407a40 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,11 @@ Conductor is a platform _originally_ created at Netflix to orchestrate microservices and events. Conductor OSS is maintained by the team of developers at [Orkes](https://orkes.io/) along with the members of the open source community. +The latest version is [![Github release](https://img.shields.io/github/v/release/conductor-oss/conductor.svg)](https://GitHub.com/conductor-oss/conductor/releases) ## Conductor OSS This is the new home for the Conductor open source going forward (previously hosted at Netflix/Conductor). -> [!IMPORTANT] -> Going forward, all the bug fixes, feature requests and security patches will be applied and released from this repository. - -The last published version of Netflix Conductor will be **3.15.0** which we will continue to support. +_The last published version of Netflix Conductor will be **3.15.0** which we will continue to support._ If you would like to participate in the roadmap and development, [please reach out](https://forms.gle/P2i1xHrxPQLrjzTB7). @@ -22,23 +20,43 @@ Show support for the Conductor OSS. Please help spread the awareness by starrin [![GitHub stars](https://img.shields.io/github/stars/conductor-oss/conductor.svg?style=social&label=Star&maxAge=)](https://GitHub.com/conductor-oss/conductor/) -## Update your local forks/clones -Please update your forks to point to this repo. This will ensure your commits and PRs can be send against this repository +## Getting Started + +### Using Docker (Recommended) +Follow the steps below to launch the docker container: + ```shell -git remote set-url origin https://github.com/conductor-oss/conductor +docker compose -f docker/docker-compose.yaml up ``` -> [!IMPORTANT] -> **Follow the steps below if you have an active PR against the Netflix/Conductor repository** -> 1. Fork **this** repository -> 2. Update your local repository to change the remote to this repository -> 3. Send a PR against the `main` branch +* Navigate to http://localhost:5000 once the container starts to launch UI. +* APIs are accessible at http://localhost:8080 +* Swagger Docs:http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/ + +## Database Requirements + +* The default persistence used is Redis +* The indexing backend is [Elasticsearch](https://www.elastic.co/) (7.x) + +## Configuration for various database backends + +| Backend | Configuration | +|----------------|---------------------------------------------------------------------------------------| +| Redis + ES7 | [config-redis.properties](docker/server/config/config-redis.properties) | +| Postgres | [config-postgres.properties](docker/server/config/config-postgres.properties) | +| Postgres + ES7 | [config-postgres-es7.properties](docker/server/config/config-postgres-es7.properties) | +| MySQL + ES7 | [config-mysql.properties](docker/server/config/config-mysql.properties) | + +## Other Requirements +* JDK 17+ +* UI requires Node 14 to build. Earlier Node versions may work but are untested. + +### Building From Source +If you wish to build your own distribution, you can run ```./gradlew build``` from this project that products the runtime artifacts. +The runnable server is in server/ module. ## Conductor OSS Roadmap [See the roadmap for the Conductor](ROADMAP.md) -## Releases -The latest version is [![Github release](https://img.shields.io/github/v/release/conductor-oss/conductor.svg)](https://GitHub.com/conductor-oss/conductor/releases) - ## Resources #### [Slack Community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) We have an active [community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) of Conductor users and contributors on the channel. @@ -52,31 +70,7 @@ Conductor supports creating workflows using JSON and Code. SDK support for creating workflows using code is available in multiple languages and can be found at https://github.com/conductor-sdk -## Getting Started - Building & Running Conductor - -### From Source: -If you wish to build your own distribution, you can run ```./gradlew build``` from this project that products the runtime artifacts. -The runnable server is in server/ module. - -### Using Docker (Recommended) -Follow the steps below to launch the docker container: - -```shell -docker compose -f docker/docker-compose.yaml up -``` -* Navigate to http://localhost:5000 once the container starts to launch UI. -* APIs are accessible at http://localhost:8080 -* Swagger Docs:http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/ - - -## Database Requirements - -* The default persistence used is Redis -* The indexing backend is [Elasticsearch](https://www.elastic.co/) (7.x) -## Other Requirements -* JDK 17+ -* UI requires Node 14 to build. Earlier Node versions may work but are untested. ## Get Support There are several ways to get in touch with us: