Skip to content

Latest commit

 

History

History
executable file
·
51 lines (44 loc) · 2.84 KB

readme.md

File metadata and controls

executable file
·
51 lines (44 loc) · 2.84 KB
Raw

The OSCAL Model Reference can be found at, https://pages.nist.gov/OSCAL/reference/latest/complete/

OSCAL Policy Administration Library (opal)

Provides a simple web application for managing System Security Plans and related documents. The data model is based on the OSCAL standard and objects can be imported and exported in OSCAL compliant JSON.

The OSCAL Model Reference can be found at, https://pages.nist.gov/OSCAL/reference/latest/complete/

  1. Python >=3.8
  2. apache
  3. postgres client if using a postgres database

Deployment Instructions

Running a local development version using sqlite

  1. Clone the repository to your local directory
    git clone https://github.com/eop-omb/opal.git
  2. Change to the new directory
    cd opal
  3. The default environment variables are set to work well in a containerized environment. To run locally you will want to set some environment variables. You cna use the provided defaults.env file to get started.
    cp opal/defaults.env opal/.env
  4. It is recommended to run the application from a virtual environment. To do so navigate to the application directory in a terminal and enter the following commands:
    python3 -m venv venv
    source venv/bin/activate
  5. Install the required python modules by running:
    pip install -r requirements.txt
  6. Run the initial migration to create the database objects:
    python manage.py makemigrations
    python manage.py migrate
  7. Create a superuser:
    python manage.py createsuperuser
  8. Start the Server
    python manage.py runserver

Start the app in a docker container using sqlite

  1. Clone the repository to your local directory git clone https://github.com/eop-omb/opal.git
  2. Build the image
    docker build -t opal .
  3. Run the container
    docker run --rm -it --name opal -p 8000:8000 -e LOG_LEVEL=DEBUG opal

Run OPAL with a Postgres database including persistent storage using docker-compose

  1. Clone the repository to your local directory git clone https://gitlab.max.gov/max-security/opal.git
  2. Run the docker-compose. YAML file in the docs/docker-compose/ folder
    cd docs/docker-compose docker-compose up

Setting environment variables

OPAL is designed to run well in a containerized environment. It is recommended to set any desired environment variables using your chosen container orchestration solution (kubernetes, docker-compose, etc.). You can also set environment variables in a .env file which should be placed in the opal subdirectory. All variables are optional and will be populated with reasonable defaults if not provided.

NOTE: defaults will be applied if the environment variable is NOT provided, but if you provide an empty string or something similar the application will not overwrite that with the default value.

You can find a list of all environment variables and their defaults in the opal/settings.py file.