Skip to content

Commit

Permalink
Absolute links for correct PyPI rst parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
greg-sk committed Mar 26, 2014
1 parent 47bf22e commit 8d0b463
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 15 deletions.
6 changes: 6 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
CHANGES
---------------------------------

v0.0.1, 2014-03-05 -- Initial release.
v0.1.2, 2014-03-25 -- Deployment ready.
v0.1.19, 2014-03-26 -- Multiple fixes: non-restful mode, README, PUT/DELETE actions, error handling
6 changes: 0 additions & 6 deletions CHANGES.txt

This file was deleted.

17 changes: 10 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
=====================
rfw - remote firewall
=====================

Remote firewall as a web service.
**Remote firewall as a web service.**

``rfw`` is the RESTful server which applies iptables rules to block or allow IP addresses on request from a remote client. ``rfw`` maintains the list of blocked IP addresses which may be updated on the fly from many sources. ``rfw`` also solves the problem of concurrent modifications to iptables since the requests are serialized.

Expand Down Expand Up @@ -93,7 +92,7 @@ Generate keys and certificates with config/deploy/rfwgen::

./rfwgen <server_ip>

See `rfwgen README <config/deploy/README.rst>`__ for more details.
See `rfwgen README <https://github.com/securitykiss-com/rfw/blob/master/config/deploy/README.rst>`__ for more details.


Fill blanks in configuration file /etc/rfw/rfw.conf and /etc/rfw/white.list.
Expand All @@ -105,11 +104,15 @@ Run in verbose mode with default config file::

Test with curl::

curl -v --cacert config/deploy/client/ca.crt --user myuser:mypasswd https://<server_ip>:7393/drop/input/eth0/1.2.3.4
curl -v --cacert config/deploy/client/ca.crt --user myuser:mypasswd -XPUT https://<server_ip>:7393/drop/input/eth0/1.2.3.4

or when testing on localhost you can skip certificate verification::

curl -v --insecure --user myuser:mypasswd https://127.0.0.1:8443/drop/input/eth0/1.2.3.4
curl -v --insecure --user myuser:mypasswd -XPUT https://127.0.0.1:7393/drop/input/eth0/1.2.3.4

or when ``local.server`` enabled there is no authorization::

curl -v -XPUT http://localhost:7390/drop/input/eth0/1.2.3.4

Run rfw without installing
--------------------------
Expand Down Expand Up @@ -163,8 +166,8 @@ Security of rfw was the primary concern from the very beginning and influenced t
License
-------

Copyrite (c) 2014 `SecurityKISS Ltd <http://www.securitykiss.com>`_,
released under the `MIT License <LICENSE.txt>`_
Copyrite (c) 2014 `SecurityKISS Ltd <http://www.securitykiss.com>`__,
released under the `MIT License <https://github.com/securitykiss-com/rfw/blob/master/LICENSE.txt>`__

| Yes, Mr patent attorney, you have nothing to do here. Find a decent job instead.
| Fight intellectual "property".
2 changes: 1 addition & 1 deletion rfw/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.1.9"
__version__ = "0.1.19"
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def read(*filenames, **kwargs):
packages = ['rfw'],
scripts = ['bin/rfw'],
data_files = [ ('/etc/rfw', ['config/rfw.conf', 'config/white.list']), ('/etc/rfw/deploy', ['config/deploy/rfwgen', 'config/deploy/README.rst'])],
long_description = read('README.rst'),
long_description = read('README.rst', 'CHANGES.rst'),
cmdclass = {'install': post_install},
classifiers=[
"Development Status :: 4 - Beta",
Expand Down

0 comments on commit 8d0b463

Please sign in to comment.