Setup OS Requirements Windows

The Peek platform is designed to run on Linux, however, it is compatible with windows. Please read through all of the documentation before commencing the installation procedure.

TODO: Upgrade to PostgreSQL 12 TODO: Add timescale support

Installation Objective

This Installation Guide contains specific Windows operating system requirements for the configuring of synerty-peek.

Required Software

Some of the software to be installed requires internet access. For offline installation some steps are required to be installed on another online server for the files to be packaged and transferred to the offline server.

Below is a list of all the required software:

  • Microsoft .NET Framework 3.5 Service Pack 1
  • Visual C++ Build Tools 2015
  • PostgresSQL 10.4+
  • Node.js 7+ and NPM 5+
  • Python 3.6
  • Virtualenv
  • FreeTDS
  • Msys Git

Optional Software

  • 7zip
  • Notepad ++
  • Installing Oracle Libraries (Instructions in the procedure)

Installation of 7zip is optional. This tool will come in handy during the process but is not required.

Installation of Notepad ++ is optional. Notepad ++ is a handy tool for viewing documents and has useful features.

Installing Oracle Libraries is required if you intend on installing the peek agent. Instruction for installing the Oracle Libraries are in the Online Installation Guide.

OS Commands

The config file for each service in the peek platform describes the location of the BASH interpreter. Peek is coded to use the bash interpreter and basic posix compliant utilities for all OS commands.

When peek generates it’s config it should automatically choose the right interpreter.

"C:\Program Files\Git\bin\bash.exe" if isWindows else "/bin/bash"

Installation Guide

The following sections begin the installation procedure.

Create Peek OS User

Create a windows user account for peek with admin rights. Search for Computer Management from the start menu, and create the new peek user from there.


Make sure the username is all lower case.

Account Type:Administrator

Sign in to the peek account.


All steps after this point assume you’re logged in as the peek user.


Run the “control userpasswords2” command from the run window to have peek automatically login. This is useful for development virtual machines.

Visual C++ Build Tools 2015

Online Installation:


Offline Installation:

Install using the ISO


Setup Msys Git


Use all default options, Except on the Adjusting your PATH environment screen.

On the “Adjusting your PATH environment” screen, select “Use Git and optional Unix tools from the Windows Command Prompt”



This is equivalent to adding “C:\Program Files\Git\mingw64\bin” and “C:\Program Files\Git\usr\bin” to the system PATH environment variable.

Open a new command window, and type bash, it should find the bash command.

Press Ctrl+D to exit bash.

Open a new command or powershell window, and type git, it should find the git command.

Install PostgresSQL

Peek requires PostgreSQL as it’s persistent, relational data store.



Ensure you download the 64bit version or PostgreSQL or the Peek windows service dependencies will not recognise it (“postgresql-10” vs “postgresql-x64-10”)


Install PostgresSQL with default settings.

Make a note of the postgres user password that you supply, you’ll need this.


Generate a strong password for both peek and postgres users for production use.

Synerty recommends 32 to 40 chars of capitals, lower case and numbers, with some punctuation, best to avoid these ` / \ ‘ “

Run pgAdmin4

Open the Query Tool


Create the peek user, run the following script:



Replace PASSWORD with a secure password from for production.



Create the peek database, run the following script:

    OWNER = peek

Confirm database was created

../../_images/pgAdmin4-refresh.jpg ../../_images/pgAdmin4-peekDatabase.jpg

Install Python 3.6


Check the ‘Add Python 3.6 to PATH’ and select ‘Customize Installation’


Update the ‘Customize install location’ to PATH C:\Users\peek\Python36\


Confirm PATH(s) to environment variables

echo %PATH%



Virtual Environment

synerty-peek is deployed into python virtual environments. Install the virtualenv python package

Upgrade pip:

pip install --upgrade pip

Open the command prompt and run the following command:

pip install virtualenv

The Wheel package is required for building platform and plugin releases

pip install wheel

Install Worker Dependencies

Install the parallel processing queue we use for the peek-worker-service tasks.

Download and install Redis:


Download and install Erlang:


Download and install RabbitMQ:


Under Control Panel -> System -> Advanced system settings

Add the following to PATH in the “System” environment variables

C:\Program Files\RabbitMQ Server\rabbitmq_server-3.6.10\sbin


On Win 10, enter “environment” in the task bar search and select Edit the system environment variables

Enable the RabbitMQ management plugins:

rabbitmq-plugins enable rabbitmq_mqtt
rabbitmq-plugins enable rabbitmq_management

Confirm the RabbitMQ Management Console and the RabbitMQ MQTT Adaptor are listed under the running applications:

rabbitmqctl status

Install Oracle Client (Optional)

The oracle libraries are optional. Install them where the agent runs if you are going to interface with an oracle database.

Download the following from oracle.

The version used in these instructions is

  1. Download the ZIP “Basic Package” p from
  2. Download the ZIP “SDK Package” from

Extract both the zip files to C:\Users\peek\oracle

Under Control Panel -> System -> Advanced system settings

Add the following to PATH in the “User” environment variables



On Win 10, enter “environment” in the task bar search and select Edit the system environment variables

The Oracle instant client needs msvcr120.dll to run.

Download and install the x64 version from the following microsoft site.

Reboot windows, or logout and login to ensure the PATH updates.

Install FreeTDS (Optional)

FreeTDS is an open source driver for the TDS protocol, this is the protocol used to talk to a MSSQL SQLServer database.

Peek needs this installed if it uses the pymssql python database driver, which depends on FreeTDS.


Unzip contents into


Rename C:\users\peek\freetds-v0.95.95 to C:\users\peek\freetds

Under Control Panel -> System -> Advanced system settings

Add the following to PATH in the “System” environment variables



On Win 10, enter “environment” in the task bar search and select Edit the system environment variables

Create file freetds.conf in C:\

    port = 1433
    instance = peek
    tds version = 7.4

If you want to get more debug information, add the dump file line to the [global] section Keep in mind that the dump file takes a lot of space.

    port = 1433
    instance = peek
    tds version = 7.4
    dump file = c:\\users\\peek\\freetds.log

dll files


Ensure these files are in the system32 folder:

  • libeay32.dll
  • ssleay32.dll

You will need to duplicate the above files and name them as per below:

  • libeay32MD.dll
  • ssleay32MD.dll

What Next?

Refer back to the How to Use Peek Documentation guide to see which document to follow next.