webhook-tunnel - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "webhook-tunnel",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A little http proxy suitable to create tunnel for web hooks endpoint living behind a firewall or a VPN",
@@ -11,3 +11,3 @@ "main": "src/index.js",
   "engines": {
-    "node": ">=6"
+    "node": ">=8"
   },
@@ -19,2 +19,4 @@ "engine-strict": true,
     "test": "npm run test:lint && npm run test:unit",
+    "package:create": "pkg . -t node8-win,node8-macos,node8-linux --out-dir build",
+    "package:publish": "node scripts/publish-release $GITHUB_TOKEN lmammino/webhook-tunnel $npm_package_version",
     "release:tag": "git tag $npm_package_version && git push --tags"
@@ -48,3 +50,5 @@ },
     "eslint-plugin-standard": "^3.0.1",
-    "jest": "^21.2.1"
+    "jest": "^21.2.1",
+    "pkg": "^4.3.0-beta.1",
+    "request-promise": "^4.2.2"
   },
@@ -51,0 +55,0 @@ "dependencies": {

README.md

@@ -10,1 +10,68 @@ # webhook-tunnel
 A little http proxy suitable to create tunnel for web hooks endpoint living behind a firewall or a VPN
+
+
+## Rationale
+
+If you are doing security properly in your company it's very likely that most of your resources will be
+protected behind a firewall or a VPN, including things like Continuous Integration pipelines (e.g. Jenkins)
+or other web based tools.
+
+In such scenarios it becomes tricky to integrate external services (e.g. GitHub) with your internal tools
+through web hooks.
+
+For example it becomes hard to allow GitHub to notify your secured CI instance that there's a new commit
+on one of the projects your CI is building.
+
+This tool allows you to create a tunnel that can be used for routing web hooks requests through your
+security layer.
+
+This approach, of course, creates a connection channel from the outside to your internal infrastructure,
+so be sure to limit the access to the tunnel as much as you can.
+
+
+## Install
+
+From npm:
+
+```bash
+npm install --global webhook-tunnel
+```
+
+(this requires [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/) version >= 8)
+
+
+Or you can simply download one of the binaries available in the [Releases](https://github.com/lmammino/webhook-tunnel/releases) section.
+
+Note: the compiled executable contains a full-blown version of the Node.js runtime
+embedded in it. So use this version only if you want to run the tunnel in an environment that
+does not have a supported version of Node.js already installed.
+
+
+## Execute
+
+To execute the proxy in your server:
+
+```bash
+webhook-tunnel <port> <target>
+```
+
+Where `port` is the port on which the proxy will be listening to and `target` is the
+full URL where every request will be proxied to.
+
+E.g.
+
+```bash
+webhook-tunnel 12345 http://myprivatejenkins.tld/somepath/
+```
+
+
+## Contributing
+
+Everyone is very welcome to contribute to this project.
+You can contribute just by submitting bugs or suggesting improvements by
+[opening an issue on GitHub](https://github.com/lmammino/webhook-tunnel/issues).
+
+
+## License
+
+Licensed under [MIT License](LICENSE). © Luciano Mammino.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

77

increased by670%

Worsened metrics

Total package byte prevSize

6561

decreased by-96.13%

Dev dependency count

9

increased by28.57%

Number of package files

7

decreased by-22.22%

Lines of code

16

decreased by-99.69%

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes