Install

Simple Installation

The simplest way to get NightCAP up and running is using the INSTALLER/installer.sh script

This will install the needed pip packages and the custom packages needed for the program.

!! Warning !!

• There are a few things that will not get installed with the bash script, they need to be installed manually and set up before running the installer script.

1. Docker

2. pyenv

   • You also need to create and enter a virtual environment. An example of this is.

        ```
         pyenv install 3.8.1
         pyenv virtualenv 3.8.1 nightcap
         pyenv activate nightcap
     
         cd <location of nightcap>
        ```
     

Install Dependencies

• Only needed if you are planning to run only the Database Container, and Nightcap on the host computer.

sh ./INSTALLER/installer.sh

Start Docker Containers

• For Database Container Only

docker-compose -f docker-compose.yml up --build -d

Use Ubuntu Container to run Nightcap

• For Ubuntu Container and Database Container

docker-compose -f docker-compose.yml -f docker-compose-ubuntu.yml up --build -d

Start Nightcap

• If you are running the Ubuntu Container for Nightcap, connect to the container then run the command below.

python ./nightcap.py