OS & Architectures

Synpse differently from other IoT platforms supports bring your own OS. This enabled any custom device usecases.

Operating System requirements

Currently, synpse required systemd or SysV to be present in the hosting operating system.

Synpse does not have hard requirements on operating system where it runs. We support a range of options as long as those options can support these requirements:

• Linux based (Windows support is coming soon)

• systemd or SysV is present

• Docker as runtime with minimum 19.03.8 version

We recommend using Ubuntu or Raspberry Pi OS which is Debian based. For more details see the image building guide.

Supported architectures

Synpse support these architectures (32 and 64 bit)

• AMD64

• ARM (32 bit) (armv7, armv6, etc)

• ARM64 (armv8)

Synpse agent is using low-level database which might not work on niche hardware and os architectures. If you find one - let us know so we can adjust our architecture to support your device

Windows support

Windows support is Beta

You can run Synpse agent on windows using Windows Subsystem for Linux provided Docker.

Pre-requisites:

1. WSL2 ubuntu installed https://docs.microsoft.com/en-us/windows/wsl/install
2. Docker desktop installed https://docs.docker.com/desktop/windows/wsl/
3. Enable Docker engine to work with WSL:

Docker engine configuration

4. Open privileged PowerShell terminal by right-clicking on the Windows PowerShell icon. And run "Run as administrator"

Priviledged shell

5. Download and install Synpse agent:

iwr https://downloads.synpse.net/install.ps1 -useb -OutFile install.ps1
./insatll.ps1 -AgentProject {agent_projecct} -AgentRegistrationToken {token_value} -AgentRegistrationToken {token}

Permissions & security

Golang binaries are well known to be seen as malwares by Windows-based os. More on this can be found in microsoft documentation, go FAQ and reddit.

For this reason, we need to whitelist Synpse install folder in windows defender for Synpse to work. Particularly this is blocking the auto-upgrade feature.

How to exclude synpse from Windows Security checker?

Search for "Windows Security" in the Windows search bar:

Go to Virus & threat protection -> Under Virus & threat protection settings, select Manage settings, and then under Exclusions, select Add or remove exclusions. Select Add an exclusion, and then select folders and add C:\Program Files\Synpse

This is the main folder where Synpse will create a temporary agent file and do in-place upgrades