aircloakTrainingApp

App used to help users learn the Aircloak system.

The app is based on the bottle web framework.

To configure

Example menu items

Add menu items to demoConfig.py.

Environment Variables

Mandatory

There are no mandatory environment variables at this time.

Optional

• NATIVE_PASS (password for native postgres, defaults to 'demo')
• TRUSTED_PASS (password for trusted user, defaults to 'demo')
• UNTRUSTED_PASS (password for untrusted user, defaults to 'demo')
• PORT (defaults to 8080)
• DATA_DIR (holds the database 'training.db', defaults to '.')
• LOG_DIR (holds the log file 'training.log', defaults to '.')
• NATIVE_USER (user name for native postgres, defaults to 'trainingApp')
• NATIVE_PORT (defaults to 5432)
• NATIVE_HOST (defaults to db001.gda-score.org)
• CLOAK_USER (user name for cloak postgres, defaults to 'training')
• CLOAK_PORT (defaults to 9432)
• CLOAK_HOST (defaults to db001.gda-score.org)

Populating the cache

The app keeps query answers in a cache for immediate display.

The URL domain:port/clearCache clears the cache.

The URL domain:port/populateCache adds any example entries not already in the cache to the cache.

The URL domain:port/cache/n adds the nth example entry to the cache, overwriting the previous entry is there was one.

The script showExampleNumbers.py prints out the index value n for each example that contains SQL. This aids in knowing the value of n for the domain:port/cache/n URL.

The script updateScript.py calls domain:port/cache/n for every value of n. This can be used to modify all values. Note that updateScript.py will simply pass by any queries that produced an error. In other words, it is not reliable.

Updating dependencies

When adding new dependencies add them to devel-requirements.txt and run make deps. This will download the required dependencies in your local virtual environment and also updated the requirements.txt file used when deploying the application

To run

• Download dependencies using make deps
• If running locally
  • Make a copy of .env-dev-sample and save it as .env-dev and edit it to fit your setup
  • Start the app with make start-local
• If running elsewhere start the app with make start and supply the required environment variables

The app automatically restarts with any code changes.