More comments in config files

hitier
1 parent 06a8b735
Showing 4 changed files with 73 additions and 33 deletions Show diff stats
INSTALL.md
resources/db_config.py
resources/flaskenv
resources/pdc_config.py
@@ -5,12 +5,14 @@
 - python3
 - sqlite ( pour le développement et les tests unitaires )
 - chrome-driver et chromium ( pour les tests unitaires)
-- postgresql ou mariadb (pour la production)
+- postgresql ou mysql/mariadb ( pour la production )
  
 ## Obtenir un répertoire fonctionnel
  
+    export GIT_SSL_NO_VERIFY=1
     git clone https://gitlab.irap.omp.eu/PDC-IRAP/pdc-web.git
     cd pdc-web
+    git checkout dev # éventuellement travailler avec la branche la plus à jour
  
 ### Installer l'environment python
  
@@ -27,7 +29,7 @@
     cp resources/db_config.py .
     $(EDITOR) db_config.py 
  
-    # Ensuite l'appli elle même (ce fichier est utilisable tel quel)
+    # Ensuite l'application elle même (ce fichier est utilisable tel quel)
     cp resources/flaskenv .flaskenv
     $(EDITOR) .flaskenv
  
+# Here are the databases configuration models for the main database engines:
+# sqlite, mysql, postgresql
+#
+# Edit the one you need, then set proper variable at the end of the file.
+#
+
 SQLITE = {
-    'file': '/home/user/tmp/pdc.db'
+    'file': '/path/to/directory/pdc.db'
 }
 sqlite_uri = 'sqlite:///%(file)s' % SQLITE
  
 MYSQL = {
     'user': 'mysql',
     'pw': 'mysql',
-    'db': 'pdc_dev',
+    'db': 'pdc_db',
     'host': '127.0.0.1',
     'port': '3306',
 }
 mysql_uri = 'mysql+pymysql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % MYSQL
  
 POSTGRES = {
-    'user': 'aroma-user',
-    'pw': 'aroma-pwd',
-    'db': 'aroma-db',
+    'user': 'pdc-user',
+    'pw': 'pdc-pwd',
+    'db': 'pdc-db',
     'host': '127.0.0.1',
     'port': '5432',
 }
 postgres_uri = 'postgresql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % POSTGRES
  
-POSTGRESDEV = {
-    'user': 'aroma-user',
-    'pw': 'aroma-pwd',
-    'db': 'aroma-dev-db',
-    'host': '127.0.0.1',
-    'port': '5433',
-}
-postgres_dev_uri = 'postgresql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % POSTGRESDEV
-
+# If needed, use other databases depending on the development phase you are on:
+# testing, dev, or production: see below for the proper var to set.
+#
 POSTGRESTEST = {
-    'user': 'aroma-user',
-    'pw': 'aroma-pwd',
-    'db': 'aroma-test-db',
+    'user': 'pdctest-user',
+    'pw': 'pdctest-pwd',
+    'db': 'pdctest-test-db',
     'host': '127.0.0.1',
     'port': '5434',
 }
 postgres_test_uri = 'postgresql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % POSTGRESTEST
  
 # The lesia mysql agents database
+# It is possible to connect to a lesia like mysql db.
+#  set it here
 MYSQL_LESIA = {
     'user': 'mysql',
     'pw': 'mysql',
-    'db': 'pdc_dev',
+    'db': 'lesia_db',
     'host': '127.0.0.1',
     'port': '3306',
 }
 mysql_lesia_uri = 'mysql+pymysql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % MYSQL
  
-# Here, set you database uri
-# will be imported in ./pdc_config.py
+# To set you databases uri,
+# uncomment the needed lines to fit your specific needs;
+# they will be imported in ./pdc_config.py
+# ( remember to edit the corresponding database setting above )
 #
-# sqlalchemy_database_uri = 'sqlite:///:memory:'
-# sqlalchemy_database_uri = 'sqlite:///another-app.db'
+
+# The main database for a production site:
+# ( defaults to an sqlite db file )
+#
+# sqlalchemy_database_uri = mysql_uri
+# sqlalchemy_database_uri = sqlite_uri
 # sqlalchemy_database_uri = postgres_uri
-# sqlalchemy_testdb_uri = postgres_test_uri
+
+# The development database:
+# ( defaults to an sqlite db file )
+#
 # sqlalchemy_devdb_uri = postgres_dev_uri
-sqlalchemy_devdb_uri = 'sqlite:///another-app.db'
+
+# The unit tests database:
+# ( defaults to in memory sqlite db: 'sqlite:///:memory:' )
+#
+# sqlalchemy_testdb_uri = postgres_test_uri
+# flask command configuration file.
+#
+# cf https://flask.palletsprojects.com/en/1.1.x/cli/
+# and https://flask.palletsprojects.com/en/1.1.x/config/
+#
+
+# Default set to 'production',
+# but 'development' value adds debuging facities.
+#
 FLASK_ENV=development
+
+# Is set to the python application wrapper
+# you shouldnt edit.
+#
 FLASK_APP=pdc_web
@@ -20,26 +20,28 @@ class Config(object):
     # Please change the following to fit you own site parameters
     #
     PDC_APP_NAME = 'Plan de Charge'
-    PDC_SITE_NAME = 'NO_SITE'  # choose among IRAP, PUBLIC, ...
-    PDC_SITE_CLASS = 'public-icon'  # choose among admin-icon, public-icon
-    PDC_LOGS_LEVEL = 'DEBUG'  # choose within  DEBUG, INFO, WARN, ERROR ( more levels in logging module )
+    PDC_SITE_NAME = 'NO_SITE'  # choose among DEV, IRAP, LESIA, LAM ... will display on page's title
+    PDC_SITE_CLASS = 'public-icon'  # choose among admin-icon, public-icon, dev-icon, see more in app/static/style.css
+    PDC_LOGS_LEVEL = 'ERROR'  # choose within  DEBUG, INFO, WARN, ERROR ( more in the python logging module )
     PDC_LOGS_DIR = os.path.join(root_dir, 'logs')
     PDC_LOGS_FILE = os.path.join(PDC_LOGS_DIR, 'pdc.log')
  
     # Uncomment for role access control
+    #
     #   if True, will disable any role control on routes
     #   note that this doesnt disable the @login_required
     #
     # ROLE_DISABLED = False
  
     # Uncomment for site access control
+    #
     #   if True, will force login access on any site page 
-    #   note that this doesnt disable the @login_required 
     #
     # SITE_LOGIN = False
  
     #
     # No need to Edit below
+    # ( but keep reading )
     #
  
     # You can force logging to stdout in production environment
@@ -55,7 +57,7 @@ class Config(object):
         SQLALCHEMY_DATABASE_URI = sqlalchemy_database_uri
     except NameError:
         SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
-                                  'sqlite:///' + os.path.join(root_dir, 'pdc_app.db')
+                                  'sqlite:///' + os.path.join(root_dir, 'pdc.db')
  
     try:
         LESIA_AGENTS_DB_URI = mysql_lesia_uri
@@ -67,35 +69,43 @@ class Config(object):
         VERSION = version_file.read().strip()
  
  
+# Production configuration
+#
 class ProdConfig(Config):
     TESTING = False
     DEBUG = False
  
  
+# Development configuration
+#
 class DevConfig(Config):
     DEBUG = True
+
     # Trying to set specific db uri from ./db_config.py
     try:
         SQLALCHEMY_DATABASE_URI = sqlalchemy_devdb_uri
     except NameError:
         SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
-                                  'sqlite:///' + os.path.join(root_dir, 'pdc_app_dev.db')
+                                  'sqlite:///' + os.path.join(root_dir, 'pdc_dev.db')
     # ignores @login_required decorator
     LOGIN_DISABLED = True
     # ignores @role_required decorator
     ROLE_DISABLED = True
  
  
+# Testing configuration
+#
 class TestConfig(Config):
     TESTING = True
     DEBUG = True
     PDC_LOGS_LEVEL = 'ERROR'  # choose within  DEBUG, INFO, WARN, ERROR ( more levels in logging module )
+
     # Trying to set specific db uri from ./db_config.py
     try:
         SQLALCHEMY_DATABASE_URI = sqlalchemy_testdb_uri
     except NameError:
         SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
-                                  'sqlite:///' + os.path.join(root_dir, 'pdc_app_test.db')
+                                  'sqlite:///' + os.path.join(root_dir, 'pdc_test.db')
     # ignores @login_required decorator
     LOGIN_DISABLED = True
     # ignores @role_required decorator