Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dev2lead committed Jun 27, 2018
1 parent 000a6bf commit f53022b
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
@@ -1,6 +1,6 @@
# *UPPERSAFE Open Source Firewall*

OSFW is a firewall, fully written in Python 3, that provides an IP / domain filtering based on a collection of public threat intelligence feeds.
OSFW is a firewall, fully written in Python 3, that provides an IP / domain filtering based on a collection of threat intelligence public feeds.

It blocks in real time incoming and outcoming traffic considered as *malicious* (matching the filtering rules automatically set up for each threat).

Expand All @@ -20,25 +20,25 @@ OSFW includes 3 main components:

Setup the virtual environment:

`python3 -m venv venv`
`source venv/bin/activate`
`pip install -r requirements.txt`
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Start the firewall components:

`bash run.sh`
bash run.sh

Attach a screen:

`screen -r osfw-sensor`
`screen -r osfw-syncfw`
`screen -r osfw-webapp`
screen -r osfw-sensor
screen -r osfw-syncfw
screen -r osfw-webapp

## Configuration

To enable the secure DNS service, simply create a symbolic link of the `unbound.conf` file to the unbound configuration directory with the following command:

`ln -s "$PWD/assets/unbound.conf" /etc/unbound/unbound.conf.d/firewall.conf`
ln -s "$PWD/assets/unbound.conf" /etc/unbound/unbound.conf.d/firewall.conf

It is possible to customize the behaviour of the firewall by editing the default `config.yaml` file.

Expand All @@ -59,7 +59,7 @@ In case you want to edit the default list, you can use a magic keyword `.tld` th
- .edu.tld
- .gov.tld

There is also a way to make a rule act as a subdomain wildcard, to do so you need to start the rule with a `.` such as the ones already in the configuration file.
There is also a way to make a rule act as a subdomain wildcard, to do so you need to start the rule with a `.` such as the ones in the default configuration file.

## Dependencies

Expand Down

0 comments on commit f53022b

Please sign in to comment.