ropereralk / conductor-ui Goto Github PK

Effective December 13, 2023, Netflix will discontinue maintenance of Conductor OSS on GitHub. This strategic decision, while difficult, is essential for realigning our resources to better serve our business objectives with our internal Conductor fork.

We are deeply grateful for your support and contributions over the years. While Netflix will no longer be maintaining this repo, members of the Conductor community have been active in promoting alternative forks of this project, we’ll leave the code as is and trust that the health of the community will remain strong and continue to develop moving forward.

The UI is a standard create-react-app React Single Page Application (SPA). To get started, with Node 14 and yarn installed, first run yarn install from within the /ui directory to retrieve package dependencies.

For more information regarding CRA configuration and usage, see the official doc site.

For upgrading users

The UI is designed to operate directly with the Conductor Server API. A Node express backend is no longer required.

To run the UI on the bundled development server, run yarn run start. Navigate your browser to http://localhost:5000.

The default setup expects that the Conductor Server API will be available at localhost:8080/api. You may select an alternate port and hostname, or rewrite the API path by editing setupProxy.js. Note that setupProxy.js is used ONLY by the development server.

There is no need to "build" the project unless you require compiled assets to host on a production web server. In this case, the project can be built with the command yarn build. The assets will be produced to /build.

Your hosting environment should make the Conductor Server API available on the same domain. This avoids complexities regarding cross-origin data fetching. The default path prefix is /api. If a different prefix is desired, plugins/fetch.js can be modified to customize the API fetch behavior.

See docker/serverAndUI for an nginx based example.

For ease of maintanence, a number of touch points for customization have been removed to /plugins.

• AppBarModules.jsx
• AppLogo.jsx
• env.js
• fetch.js

We recommend that authentication & authorization be de-coupled from the UI and handled at the web server/access gateway.

• Basic Auth (username/password) with nginx
• Commercial IAM Vendor
• Node express server with passport.js