Mirror/fail2rest
1
0
Fork 0
mirror of https://github.com/Sean-Der/fail2rest.git synced 2024-12-22 21:52:18 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source 
* Solved a double slash
* Added run as sudo comment
* Some addings to Service section
This commit is contained in:
CPJB 2015-11-02 16:12:40 +02:00 committed by Sean DuBois
parent eda3f9d57c
commit 3e2a54a130
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -32,12 +32,44 @@ fail2rest has two options that be configured via config.json
* **Fail2banSocket** - The path to the fail2ban socket, can usually be found via `grep socket /etc/fail2ban/fail2ban.conf` you also have to run fail2rest as a user who has permissions to use this socket * **Fail2banSocket** - The path to the fail2ban socket, can usually be found via `grep socket /etc/fail2ban/fail2ban.conf` you also have to run fail2rest as a user who has permissions to use this socket
* **Addr** - The address that fail2rest is served upon, it is usually best so serve to the loopback, and then allow access via nginx see an example config in the [fail2web](https://github.com/Sean-Der/fail2web) repository * **Addr** - The address that fail2rest is served upon, it is usually best so serve to the loopback, and then allow access via nginx see an example config in the [fail2web](https://github.com/Sean-Der/fail2web) repository
The default configuration file used by init-scripts is `/etc/fail2rest.json`. You should download the config to your /tmp/ dir and modify it to your needs.
cd /tmp/
wget https://raw.githubusercontent.com/Sean-Der/fail2rest/master/config.json
Once you finished editing the configuration file, you should move it from /tmp/config.json to /etc/fail2rest.json executing `mv /tmp/config.json /etc/fail2rest.json`
##Running ##Running
Once you have a config.json all you need to do is run `fail2rest --config config.json` Once you have a config.json all you need to do is run `fail2rest --config config.json`
However, fail2rest is designed to run as a service, so init scripts are provided that allow easy management of fail2rest. They can be found [here](https://github.com/Sean-Der/fail2rest/tree/master/init-scripts) However, fail2rest is designed to run as a service, so init scripts are provided that allow easy management of fail2rest. They can be found [here](https://github.com/Sean-Der/fail2rest/tree/master/init-scripts)
Download the appropriate init file your Distribution. You may need to customize your init script to load your config.json, but most scripts default to /etc/fail2rest.json Download the appropriate init file your Distribution. You may need to customize your init script to load your config.json, but most scripts default to /etc/fail2rest.json
##Service
To run as a service you can either copy or create symlinks for systemd and the fail2rest binary. The systemd file shold be added to /etc/systemd/system/fail2rest.service and the the binary to /usr/bin/fail2rest. This scenario will use the symlinks in order to always use the latest files. You should run the commands with sudo if not logged in as root:
ln -s $GOPATH/bin/fail2rest /usr/bin/
Debian
ln -s $GOPATH/src/github.com/Sean-Der/fail2rest/init-scripts/systemd /etc/systemd/system/fail2rest.service
Other Linux
ln -s $GOPATH/src/github.com/Sean-Der/fail2rest/init-scripts/systemd /usr/lib/systemd/system/fail2rest.service
Enable fail2rest service to run at startup
systemctl enable fail2rest.service
Run the following systemd command to start the fail2rest service
systemctl start fail2rest.service
Verify that the fail2rest service it is active and running
systemctl status fail2rest.service
##License ##License
The MIT License (MIT) The MIT License (MIT)