# oktoflow platform: Install Support (Windows)

### Prepare the server
>Please note that the software versions may have changed. The most current versions are listed in the platform prerequisites documentation: [Prerequisites](https://github.com/iip-ecosphere/platform/blob/main/platform/documentation/PREREQUISITES.md).

On the device, where we will build and instantiate the platform also for the devices, install the programs unzip, Java JDK (version 17 or up due to some limitations of used dependencies), maven (version 3.9.13) and docker (version 20.10.7):

Please verify first whether the required software is already available and whether the required versions are present:

    java -version
    mvn -version
    
If either command fails, please install the software as indicated below.    

For Java 17, please execute

     curl https://download.oracle.com/java/17/archive/jdk-17.0.10_windows-x64_bin.zip -o openjdk.zip
     tar xzpvf openjdk.zip
     setx JAVA_HOME "%cd%\jdk-17.0.10"
     SET JAVA_HOME=%cd%\jdk-17.0.10
     setx Path "%Path%;%JAVA_HOME%\bin"
     SET Path=%Path%;%JAVA_HOME%\bin
     netsh advfirewall firewall add rule name="Java" dir=in action=allow program="%JAVA_HOME%\bin\java.exe" enable=yes

For Maven 3.9.7 is not installed, please execute

     curl https://archive.apache.org/dist/maven/maven-3/3.9.7/binaries/apache-maven-3.9.7-bin.zip -o maven.zip
     tar xzpvf maven.zip
     setx MAVEN_HOME "%cd%\apache-maven-3.9.7"
     SET MAVEN_HOME=%cd%\apache-maven-3.9.7
     setx Path "%Path%;%MAVEN_HOME%\bin"
     SET Path=%Path%;%MAVEN_HOME%\bin

If you plan to use a different local repository than `~/.m2/repository` then please set `M2_REPO` to that directory as oktoflow may rely at runtime on the libraries stored there.
     
For Python 3.9, please execute 

    curl https://www.python.org/ftp/python/3.9.13/python-3.9.13-amd64.exe -o python-3.9.13-amd64.exe
    python-3.9.13-amd64.exe
    SET Path=%Path%;C:\Program Files\Python39\Scripts\;C:\Program Files\Python39\

Also install the required python packages

    python -m pip install numpy==1.20.1
    python -m pip install pickle4
    python -m pip install pyflakes==3.3.2
    python -m pip install PyYAML==6.0
    python -m pip install websockets==11.0.2
    

Docker is not a required prerequisite, but if we want to use Docker containers provided by the platform, or to create Docker images for applications that require Docker.

We recommend using Docker version 4.68.0, please execute 

    curl https://desktop.docker.com/win/main/amd64/223695/Docker%20Desktop%20Installer.exe -O DockerDesktopInstaller.exe
    rename "Docker%%20Desktop%%20Installer.exe" DockerDesktopInstaller.exe
    start /w "" "DockerDesktopInstaller.exe" install
    
Please note that for executing Linux containers on Windows (as the containers created by the platform) the Windows Sub system for Linux (WSL) is required. Please follow the [WSL Installation Instructions](https://learn.microsoft.com/en-us/windows/wsl/install-manual).

For distributing containers created by the platform, we need a local Docker registry, in particular if services contain IPR-protected code. We install the registry on the server on port 5001 as follows:

    docker run -d \
      --restart=always \
      --name registry \
      -e REGISTRY_HTTP_ADDR=0.0.0.0:5001 \
      -p 5001:5001 \
      registry:2

In general, we recommend using a distinct server for this and to adjust the settings in the platform configuration.

You may check the registry using ("147.172.178.145" should be changed to the IP address of your machine)
    
    curl -sS http://147.172.178.145:5001/v2/_catalog
    
### Prepare the devices

On devices, the installation may differ depending on the desired degree of containerization. If you want to run the fundamental platform components on bare metal, please install also JDK, Maven, Python, Python packages and Docker on the devices. If you plan to run only containers on the devices, docker is sufficient.

Create or edit the ``daemon.json`` file (usually in ``C:\ProgramData\Docker\config\daemon.json``) in order to access the local Docker registry installed above, here without TLS certificate ("147.172.178.145" should be changed to the IP address of your machine that running the Docker registry). For an empty file, this looks like:

    {
      "insecure-registries" : ["147.172.178.145:5001"]
    }
    
Then a restart of docker may be required.

### Prepare Python

Depending on the use of Python in services, the build process for applications may include Python syntax checking and execution of Python unit tests. If you plan to run the platform on bare metal under administrator permissions, e.g., as systemd service, please install the following python dependencies globally, i.e., with administrator permissions.

At least pyflakes and for service execution PyYaml as well as websockets must be installed (Please check the tested library for each version of Python  [Prerequisites](https://github.com/iip-ecosphere/platform/blob/main/platform/documentation/PREREQUISITES.md))

    python -m pip install pyflakes==2.5.0
    python -m pip install PyYAML==6.0
    python -m pip install websockets==11.0.2
 
Moreover, depending on the utilized platform functions potentially also pyzbar, opencv-python, numpy, and Pillow are required for the data processing function library:

    python -m pip install numpy==1.20.1
    python -m pip install pyzbar==0.1.9
    python -m pip install opencv-python==4.5.5.64
    python -m pip install Pillow==9.1.0
    python -m pip install pickle4

### Prepare Angular

If you intend to use the platform management user interface, Angular 14, express 4.18.1 and cors 2.8.5 are required on the server. 

    curl https://nodejs.org/download/release/v22.14.0/node-v22.14.0-x64.msi -o node-v22.14.0-x64.msi
    node-v22.14.0-x64.msi
    setx Path "%Path%;C:\Program Files\nodejs"
    SET Path=%Path%;C:\Program Files\nodejs
    npm install -g @angular/cli@19.2.5
    npm install -g express@4.18.1
    npm install -g cors@2.8.5