README updated - documentation

makuga01 · Sep 17, 2019 · 76f7a91 · 76f7a91
1 parent 7f95bc5
commit 76f7a91
Show file tree

Hide file tree

Showing 7 changed files with 390 additions and 19 deletions.
diff --git a/BE/__pycache__/app.cpython-36.pyc b/BE/__pycache__/app.cpython-36.pyc
diff --git a/BE/__pycache__/dns_resources.cpython-36.pyc b/BE/__pycache__/dns_resources.cpython-36.pyc
diff --git a/BE/app.py b/BE/app.py
@@ -9,9 +9,11 @@
 api = Api(app)
 cors = CORS(app, resources={r"/*": {"origins": "*"}})
 
+"""
+*** CONFIG ***
+"""
 
-
-DB_URL = 'postgresql+psycopg2://postgres:docker@localhost/dnsfookup'
+DB_URL = 'postgresql+psycopg2://postgres:CHANGETHISTOO@localhost/dnsfookup'
 
 app.config['SQLALCHEMY_DATABASE_URI'] = DB_URL
 app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False # silence the deprecation warning
@@ -30,6 +32,10 @@ def create_tables():
 app.config['JWT_BLACKLIST_TOKEN_CHECKS'] = ['access']#, 'refresh]
 app.config['JWT_ACCESS_TOKEN_EXPIRES'] = 60*60*6 # 6 hours
 
+"""
+*** CONFIG ***
+"""
+
 @jwt.token_in_blacklist_loader
 def check_if_token_in_blacklist(decrypted_token):
     jti = decrypted_token['jti']

diff --git a/BE/dns.py b/BE/dns.py
@@ -4,9 +4,13 @@
 from datetime import datetime
 
 """
-DNS SERVER CONFIG
+*** CONFIG ***
 """
 
+"""
+UDP port DNS server will listen on, for testing purposes it's on 5053,
+if you want to deploy the app on server change this to 53
+"""
 port = 5053
 ip = "127.0.0.1"
 
@@ -19,6 +23,20 @@
 """
 FAILURE_IP = '0.0.0.0'
 
+"""
+Redis configuration
+REDIS_EXP - expiration of redis key
+"""
+
+redis_config = {"host": "127.0.0.1", "port": 6379, 'password': 'CHANGETHISPW'}
+REDIS_EXP = 60 * 60  # 1 hour
+redis = StrictRedis(socket_connect_timeout=3, **redis_config)
+
+
+"""
+*** CONFIG ***
+"""
+
 """
 SQLAlchemy models for easier access to database
 """
@@ -58,15 +76,6 @@ def save_to_db(self):
         db.session.commit()
 
 
-"""
-Redis configuration
-REDIS_EXP - expiration of redis key
-"""
-
-redis_config = {"host": "127.0.0.1", "port": 6379}
-REDIS_EXP = 60 * 60  # seconds
-redis = StrictRedis(socket_connect_timeout=3, **redis_config)
-
 """
 Lambda functions used for easier manipulation with redis
 """

diff --git a/BE/dns_resources.py b/BE/dns_resources.py
@@ -6,16 +6,22 @@
 from redis import StrictRedis
 from IPy import IP
 
+"""
+*** CONFIG ***
+"""
 DOMAIN = "gel0.space"
 
 redis_config = {
   'host': '127.0.0.1',
   'port': 6379,
+  'password': 'CHANGETHISPW'
 }
 REDIS_EXP = 60*60 #seconds
 redis = StrictRedis(socket_connect_timeout=3,**redis_config)
 
-
+"""
+*** CONFIG ***
+"""
 
 """
 For easier manipulation with redis