Skip to main content

Installation

⚙ Running STATUS locally with Docker​

caution

STATUS is in a pre-production version, so it is normal that some parts of the system contain bugs, if you find any, please report them here.

Installation prerequisites​

Before starting with the installation it is necessary to install (or upgrade if the Docker version is less than 1.27.0) the following tools:

  • Docker: You can find the installation guide for your operating system here.
info

This installation includes a .env.deploy file that must be partially filled in by the user. In order to use the application correctly, you must enter this .env:

  • OpenAI API Key
  • OpenAI OrgID
  • Github Client Secret

If you don't have this information, don't worry, you will be able to use a part of the system.

Installation Guide for Windows​

  1. Open the Windows Powershell.

  2. Clone the GitHub repository with the following command:

    git clone https://github.com/statuscompliance/infrastructure

  3. Find the infrastructure folder or execute:

    cd .\infrastructure\Windows\

  4. Run the setup script:

    .\setup.ps1

  5. Enter the requested information (username, password and e-mail address to be used in the system).

  6. After the installation is complete, you can access the system at http://localhost:3000.

Installation Guide for MacOS/Linux​

  1. Open a terminal.

  2. Clone the GitHub repository by running the following command:

    git clone https://github.com/statuscompliance/infrastructure

  3. Change to the newly cloned directory:

    cd infrastructure

  4. Run the setup script:

    ./setup.sh

  5. Enter the requested information (username, password and e-mail address to be used in the system).

  6. After the installation is complete, you can access the system at http://localhost:3000.