diff --git a/README.md b/README.md index 3e9a0a2..31bec70 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,8 @@ Below you will find a list of examples that will help you learn OpenFin Deployme If you need to self-host the runtime and rvm then the following example shows you an express server that hosts a runtime/rvm and an application that takes advantage of that custom setup once you have modified the RVM's registry settings. + +## [Health-check Example](deployment-health-check/README.md) + +A sample page to show health of some webservices deployed at OpenFin with [@openfin/deployment](https://www.npmjs.com/package/@openfin/deployment) package. + diff --git a/deployment-health-check/LICENSE b/deployment-health-check/LICENSE new file mode 100644 index 0000000..195384e --- /dev/null +++ b/deployment-health-check/LICENSE @@ -0,0 +1,3 @@ +Copyright 2021-2022 OpenFin Inc. + +You may not run or in any way utilize the code in this package, unless you have executed an enterprise license directly with OpenFin. You can learn more about OpenFin licensing by emailing us at support@openfin.co with questions. diff --git a/deployment-health-check/README.md b/deployment-health-check/README.md new file mode 100644 index 0000000..5ae209b --- /dev/null +++ b/deployment-health-check/README.md @@ -0,0 +1,11 @@ +# OpenFin Service Deployment Health Check + +A sample page to show health of some webservices deployed at OpenFin with [@openfin/deployment](https://www.npmjs.com/package/@openfin/deployment) package. + +## Files + +* https://cdn.openfin.co/tools/deployment/1.0.0/openfin-deployment.js: [@openfin/deployment](https://www.npmjs.com/package/@openfin/deployment) package for checking accessiblity to OpenFin resources. CORS needs to be enabled for any endpoint in order for health check to work properly. +* src/example.ts: example for @openfin/deployment package as ES module. The exmaple can be started with `npm run start`. +* index.html: example for using \ + + +
+