A public repository making the ASU developed IP2M-METRR tool available for limited public sector use.
Please review the details of the LICENSE file included in this repository.
You can find the latest published version of IP2M-METRR here. For historical releases, please see our releases page.
Please reach out to support@pars.doe.gov for installation and configuration assistance. Within PARS, the tool is hosted in an Azure Web Apps container connecting to an Azure SQL Managed instance, but other Docker hosting tools should work. The following Environment Variables will need to be configured on your Docker host.
In order to use this app, you will need to configure an .env file that is appropriate for the environment you are trying to deploy to. These files are in the format \env\{prod/test/dev/etc}. Without configuring the environment file, you will not be able to run IP2M. An example file for env\prod\flask.env is below, with items you need to change noted in {BRACKETS}:
# Flask config
FLASK_APP=project/__init__.py
FLASK_ENV=production
FLASK_DEBUG=0
PYTHONDONTWRITEBYTECODE=1
STATIC_URL = "/static/"
STATIC_ROOT=/usr/src/app/project/build/static
PYTHONUNBUFFERED=1
ORIGINS=*
UPGRADE_FLAG=1
VERSION=2
SECRET_KEY={SECRET_KEY} # Create a secret key for your project, which is an alphanumeric string.
# POSTGRES
POSTGRES_USER={POSTGRES_USER}
POSTGRES_PASSWORD={POSTGRES_PASSWORD}
SQL_HOST={SQL_HOST}
SQL_PORT={SQL_PORT}
DATABASE={DATABASE} # Change this to whatever your DB name is, we reccomend "IP2M"
DB_URI=mssql+pymssql://{POSTGRES_USER}:{POSTGRES_PASSWORD}@SQL_HOST:{SQL_PORT}/{DATABASE}?charset=utf8
# EMAIL
MAIL_USERNAME={MAIL_USERNAME} # Change these to reflect your own email host and configuration for sending communications and password reset emails
MAIL_PASSWORD={MAIL_PASSWORD}
MAIL_SERVER={MAIL_SERVER}
# SAML
SAML_METADATA_URL={SAML_METADATA_URL} # Change this to reflect your own SAML authentication provider; This tool was original designed with Okta in mind.
# GENERAL
APP_URL=http://localhost:8001
INVITATION_EXPIRY_HOURS=24
# LOGGER
ELK_ENABLED=0
# INVITE APPROVALS
LINK_INVITE_APPROVALS_REQUIRED="USER, ADMIN"
The following sections provide for some general notes and tips for composing the Docker container and running the application. They are provided "as-is", and may not work depending on your system configuration. If you encounter issues, please reach out to PARS Support at support@pars.doe.gov.
This starter template comes with the following services
React code with material UI served at localhost:3000
Flask server for login and user management
- Install Docker (Docker desktop for mac/windows)
- Install docker-compose. Note: only do this for linux. Mac and windows install compose in the first step
You may create additional Dockerfiles and environment folders as appropriate for your own environment and testing needs. We recommend maintaining a separate database from your production database when testing, which can configure separately. For example, you might create an additional configuration file under env\test\flask.env
Once you have configured your environment file as appropriate (See example above), change your working directory to where you have the IP2M files stored, and run the following command (Running as sudo or admin is recommended if possible):
docker-compose -f docker-compose.prod.yml up -d --build --remove-orphans
When the server starts, the following users are created by default. <email>:<password>
admin@ip2m.com:Admin@123
facilitator@ip2m.com:Facilitator@123
user@ip2m.com:User@123
The first user has super user access and has CRUD access to users.
After cloning and running the docker compose up command if you see the line below in the docker logs, Then change the line endings of the ./server/entrypoint.sh or ./client/entrypoint.sh to linux line endings (LF). Then the container will run the script files.
standard_init_linux.go:228: exec user process caused: no such file or directory
If the flask server stops working. Delete the versions folder in `./server/migrations. Try the steps below to restart the flask server
docker-compose down -v
docker volume rm $(docker volume ls -q)
Then try running the docker compose up to start all the containers
docker-compose up -d --build --remove-orphans
Live reload does not work with windows file system and therefore it is recommended to use WSL 2 to work around that. In addition, you may need to change the permission settings when you get permission denied error using the following from your WSL distro (Ubuntu usually) terminal.
chmod +x deployment_scripts/entrypoint.sh
chmod +x server/entrypoint.sh
chmod +x client/entrypoint.sh
Following posts may help fix the issues that you may encounter. https://stackoverflow.com/questions/69578573/live-reload-does-not-work-in-docker-container-for-windows https://stackoverflow.com/questions/69579200/unable-to-run-docker-compose-from-wsl-2-ubuntu Note: This would make your PC really slow, such that even editing this readme and saving it would hang it and maky take a minute or more.
Start the test app service using the following command.
docker-compose -f docker-compose.test.yml up -d --build --remove-orphans
All the test cases present in the project will run by using the above command and displays test summary information with
how many test cases were passed and failed.
To get a test report on a single file, open the docker CLI command prompt and run the following command,
pytest <path_to_file>/<file_name>.pyExample
pytest tests/views/test_auth.pyIf we want to run a specific method in a test file, use the following command in docker cli
pytest <path_to_file>/<file_name>.py::<method_name>
Example
pytest tests/models/test_user.py::test_add_user