-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
0 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,15 @@ | ||
#Running | ||
To quickly run fail2rest just execute `go run *.go` | ||
|
||
#Guidelines | ||
|
||
* Put as much logic as possible into [fail2go](https://github.com/Sean-Der/fail2go) | ||
* Make sure code is properly formated [gofmt](http://blog.golang.org/go-fmt-your-code) | ||
* Make sure you code compiles | ||
* If adding new REST endpoints try to follow the current style | ||
|
||
#REST Style | ||
Currently we have three top level endpoints | ||
* /global (Get/Set information relating to fail2ban) | ||
* /jail/{jail} (Get/Set information relating to a single jail) | ||
* /wwhois/{ip} (Run a WHOIS on the given IP) |