github/portmaster
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Daniel
2019-03-08 23:12:15 +01:00
parent a70aba7e33
commit 2caa04e5e7
1 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,6 +1,6 @@
# Portmaster
The Portmaster enables you to protect your data on your device. You are back in charge of your outgoing connections: you choose what data you share and what data stays private.
The Portmaster enables you to protect your data on your device. You are back in charge of your outgoing connections: you choose what data you share and what data stays private. Read more on [docs.safing.io](http://docs.safing.io/).
## Current Status
@@ -13,18 +13,29 @@ Supported platforms:
## Usage
Just download the portmaster from the releases page.
If you do not already know, please read about [how the Portmaster works](http://docs.safing.io/).
./portmaster -db=/opt/pm_db
You can download the Portmaster from the [releases page](https://github.com/Safing/portmaster/releases):
# print help for startup options:
./portmaster -help
# (preferences can be configured using the UI)
# start the portmaster:
sudo ./portmaster -db=/opt/pm_db
# this will add some rules to iptables for traffic interception via nfqueue (and will clean up afterwards!)
# already active connections may not be handled correctly, please restart programs for clean behavior
# then start the ui
# then start the ui:
./portmaster -db=/opt/pm_db -ui
# missing files will be automatically download when first needed
# missing files will be automatically downloaded when first needed
# and the notifier:
./portmaster -db=/opt/pm_db -notifier
## Documentation
Documentation _in progress_ can be found here: [http://docs.safing.io/](http://docs.safing.io/)
Documentation _in progress_ can be found here: [docs.safing.io](http://docs.safing.io/)
## Dependencies