Package Health Score

63 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
13.1.4	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
13.1.3	\|	03/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
13.0.0	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
12.2.0	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.5.0	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (399)

GitHub Stars: 2.84K
Forks: 183
Contributors: 30

Direct Usage Popularity

The npm package @kui-shell/proxy receives a total of 399 downloads a week. As such, we scored @kui-shell/proxy popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @kui-shell/proxy, we found that it has been starred 2,843 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the @kui-shell/proxy repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 6
Last Release: 2 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of @kui-shell/proxy based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @kui-shell/proxy is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 0 Direct
Versions: 1.08K
Install Size: 187 kB
Dist-tags: 6
# of Files: 30
Maintainers: 2
TS Typings: No

@kui-shell/proxy has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

The Kui Proxy

NOTE: Internal consumption only! Don't use this directly!

It is likely that your browser deployment will not have direct API access to the backend API servers. This could be due to CORS limitations, for example. To support this use case, Kui includes a proxy server. Without the proxy in place, the Kubernetes and OpenWhisk plugins will likely not be functional when serving Kui from a browser.

The Design

The proxy design leverages a headless build of Kui, hosted in a docker image, and fronted by a thin express routing layer. The webpack build then communicates with the proxy to evaluate the commands.

Building the webpack client

Consult the webpack documentation to learn more about setting it up a webpack build.

Configuring the Proxy Interchange

The webpack client communicates to the proxy via a configuration currently defined in the proxyServerConfig variable located in proxy-executor.ts. This will be refined in the near future.

Building the Proxy

The proxy is built into a docker image via the following commands. You may choose to override the default version of kubectl via the KUBE_VERSION environment variable.

export KUBE_VERSON=v1.13.2
npm install
./build.sh

This will create an image named kui-proxy.

Running the Proxy

To run the proxy:

npm start

If you want to add debugging output, set a DEBUG environment variable to the value of your choosing:

DEBUG=* npm start

FAQs

What is @kui-shell/proxy?

Kui package that offers a proxy server. Visit Snyk Advisor to see a full health score report for @kui-shell/proxy, including popularity, security, maintenance & community analysis.

Is @kui-shell/proxy popular?

The npm package @kui-shell/proxy receives a total of 399 weekly downloads. As such, @kui-shell/proxy popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @kui-shell/proxy well maintained?

We found indications that @kui-shell/proxy is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @kui-shell/proxy safe to use?

The npm package @kui-shell/proxy was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 18:51 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

@kui-shell/proxy

Kui package that offers a proxy server For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (399)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

The Kui Proxy

The Design

Building the webpack client

Configuring the Proxy Interchange

Building the Proxy

Running the Proxy

FAQs

What is @kui-shell/proxy?

Is @kui-shell/proxy popular?

Is @kui-shell/proxy well maintained?

Is @kui-shell/proxy safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (399)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

The Kui Proxy

The Design

Building the webpack client

Configuring the Proxy Interchange

Building the Proxy

Running the Proxy

FAQs

What is @kui-shell/proxy?

Is @kui-shell/proxy popular?

Is @kui-shell/proxy well maintained?

Is @kui-shell/proxy safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues