Skip to content

Commit

Permalink
Change installation method related #9
Browse files Browse the repository at this point in the history
  • Loading branch information
Okan Ozdemir committed Mar 11, 2019
1 parent 5ceca04 commit 040d37e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Kripton Guard
Receive notification when a new device is connected to the network.
## Introduction
Kripton Guard, saves MAC addresses to a SQLite database by sending ARP packets to your network in the learning process, when the learning process is completed, it compares the devices in the network with the devices that already registered in the database. If the device is unknown it sends a notification to your phone.
Kripton Guard, saves MAC addresses to a SQLite database by sending ARP packets to your network(via [Scapy](https://github.com/secdev/scapy)) at first use, then the later uses, it compares the devices in the network with the devices that already registered in the database. If the device is unknown it sends a notification to your phone.

Kripton Guard uses [Google Firebase Authentication](https://firebase.google.com/docs/auth/) for authentication, associates your `user id` with `device id` and saves it in [Google Realtime Database](https://firebase.google.com/docs/database/). It sends you notifications via [Google Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) when new device is found.
Kripton Guard uses [Google Firebase Authentication](https://firebase.google.com/docs/auth/) for authentication, associates your `user id` with `device id` and saves it in [Google Realtime Database](https://firebase.google.com/docs/database/). It sends you notifications via [Google Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) when new device is found.

## Prerequisites

Kripton Guard uses [scapy](https://github.com/secdev/scapy), [pyrebase](https://github.com/thisbejim/Pyrebase), [python-crontab](https://github.com/doctormo/python-crontab) and these libraries will be installed automatically when installing kripton-guard pip package but you can also install them with the command below:
Kripton Guard uses [scapy](https://github.com/secdev/scapy), [pyrebase](https://github.com/thisbejim/Pyrebase), [python-crontab](https://github.com/doctormo/python-crontab) and you have to install them with the command below:
```
pip install -r requirements.txt
pip3 install -r requirements.txt
```
## Installation

Expand All @@ -21,7 +21,7 @@ Google Play Link: [Kripton-Guard](https://play.google.com/store/apps/details?id=
![](https://media.giphy.com/media/2kP6H6uOH2UXGdykiE/giphy.gif)

```
pip install kripton-guard
sudo python3 setup.py install
```

Edit `[SETTINGS]` section in [/etc/kripton-guard/kripton-guard.conf](https://github.com/COMU/kripton-guard/blob/master/kripton-guard/kripton-guard.conf "kripton-guard.conf").
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ def readme():

setup(
name="kripton-guard",
version="2.0",
version="0.1",
long_description=readme(),
classifiers=[
'Development Status :: 3 - Alpha',
Expand Down

0 comments on commit 040d37e

Please sign in to comment.