Skip to content

Commit 5b2c006

Browse files
author
Ganesh K Bhat
committed
[pgpcgijs] [docs] Adding code commit for docs. Adding security note
1 parent fc338da commit 5b2c006

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,30 @@
1010

1111
---
1212

13-
With Node PHP Embedded (PHPCGIJS), you can leverage the speed of node.js and run all of the widely available php scripts directly inside your express site.
1413

15-
`PHPCGIJS` was originally a fork of http://github.com/mkschreder/node-php. `PHPCGIJS` was later modified for making this library take dynamic PHP pathing, so that it can run without a PHP (or other interpreted language) distribution installed on a machine. `PHPCGIJS` can work with an embedded PHP binary distribution. `PHPCGIJS` was later added with [`CGIJS`](https://www.npmjs.com/package/cgijs) to make this library comprehensively support most scripting languages long with running any web application behind a proxy using a webserver.
14+
With Node PHP Embedded (PHPCGIJS), you can leverage the speed of node.js and run all of the widely available php scripts directly inside your node.js web application or site.
15+
1616

1717
## Installation
1818

1919
```
2020
npm install phpcgijs --save
2121
```
2222

23+
#### **SECURITY NOTE**:
24+
25+
26+
- The process shell module is security agnostic and is dependant on your code.
27+
- The package accesses the shell to run script executables using the node.js process module. Please consider your `security risks based on your executable's/ script's security risks`.
28+
- The proxy module is security agnostic and is dependant on your code.
29+
- The `package has a LAN or WAN network proxy module AND does not create any proxies` by its own - unless specified by you. Please consider your custom created proxy's security risks.
30+
- The `package does not use Telemetry, nor Collect data Remotely, nor has Telemetry/Remote based Error collection` on its own.
31+
- The package propogates errors for you to handle or collect errors/ data.
32+
33+
34+
# Library Features
35+
36+
2337
## Includes CGIJS Library as a dependancy
2438

2539
# cgijs
@@ -102,6 +116,12 @@ The script will pipe all files that end in the .php extension through the php pa
102116

103117
You can also use the inbuilt `cgijs` API using the following features using the `require("phpcgijs").cgijs` API.
104118

119+
120+
### NOTE:
121+
122+
`PHPCGIJS` was originally a fork of http://github.com/mkschreder/node-php. `PHPCGIJS` was later modified for making this library take dynamic PHP pathing, so that it can run without a PHP (or other interpreted language) distribution installed on a machine. `PHPCGIJS` can work with an embedded PHP binary distribution. `PHPCGIJS` was later added with [`CGIJS`](https://www.npmjs.com/package/cgijs) to make this library comprehensively support most scripting languages long with running any web application behind a proxy using a webserver.
123+
124+
105125
## Dependencies
106126

107127
#### Inbuilt phpcgijs `.cgi` usage

0 commit comments

Comments
 (0)