-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- fix commas in multi-port output - modify usage for web slightly - add README.md
- Loading branch information
Jake Teton-Landis
committed
Feb 22, 2015
1 parent
f731a73
commit 72c4ac8
Showing
4 changed files
with
55 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# firewall-my-system - instant firewall generator | ||
|
||
## Installation | ||
|
||
npm install --global firewall-my-systems | ||
|
||
## Usage | ||
|
||
### Command-line | ||
|
||
`firewall-my-systems` can be run on the command line, or accessed over HTTP | ||
using the server. Here's the usage for the command: | ||
|
||
firewall-my-system FIREWALL PORTSPEC` | ||
FIREWALL = iptables | pf | ipfw | ||
PORTSPEC = (t|u)PORTNUMBER [PORTSPEC] | ||
t for TCP | ||
u for UDP | ||
|
||
The firewalls generated are actually shell scripts that set up those firewalls, | ||
so feel free to pipe the output of this command into bash or something. | ||
|
||
Example: generate an iptables firewall script opening TCP 22, 80, and UDP 5000 | ||
|
||
firewall-my-system iptables t22 t80 u5000 | ||
|
||
### Server | ||
|
||
To start the server, run `firewall-my-systems-server`. You can specify the port | ||
by setting the `PORT` env variable: `PORT=80 firewall-my-systems-server`. | ||
|
||
Accessing the server is almost identical to using the command line, except | ||
instead of spaces deliminating positional arguments, slashes are used instead. | ||
To run the example above, you would access | ||
http://firewallmy.systems/iptables/t22/t80/u5000, although you could use commas | ||
or any other non-number character to seperate portspecs. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
{ | ||
"name": "firewall-my-systems", | ||
"version": "0.4.1", | ||
"description": "quick firewall rules builder", | ||
"version": "0.4.2", | ||
"description": "quick firewall rules builder for iptables, ipfw, and pf", | ||
"main": "index.js", | ||
"bin": { | ||
"firewall-my-systems-server": "./launch-server.js", | ||
|
@@ -11,6 +11,10 @@ | |
"start": "./node_modules/.bin/supervisor -e js,jsx,json,styl launch-server.js", | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/berke1337/firewallmy.systems" | ||
}, | ||
"keywords": [ | ||
"firewall", | ||
"rules", | ||
|
@@ -20,11 +24,17 @@ | |
"builder", | ||
"easy" | ||
], | ||
"author": "Jake Teton-Landis", | ||
"author": { | ||
"name": "Jake Teton-Landis", | ||
"url": "http://jake.teton-landis.org", | ||
"email": "[email protected]" | ||
}, | ||
"license": "GPL", | ||
"dependencies": { | ||
"babel": "^4.4.3", | ||
"express": "^4.11.2", | ||
"express": "^4.11.2" | ||
}, | ||
"devDependencies": { | ||
"supervisor": "^0.6.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters