Synpse
🤖 Devices⚡ ApplicationsTry Synpse!
  • Intro to Synpse
  • Start here
    • Quick Start (web user)
    • Quick Start (CLI)
  • Agent
    • Install
      • Raspberry Pi
      • Linux (Docker)
      • MacOS
      • NVIDIA Jetson
      • Headless (Ubuntu)
      • BeagleBoard AI
      • Bulk Provisioning
      • 🪄Beta - Universal Synpse image
      • Containerized agent
      • Configuration
    • Uninstall
  • CLI
    • Install & Usage
  • synpse core
    • Devices
      • Device Provisioning
      • HTTPS Tunnel Access
      • SSH Access
      • Device Labels
      • Environment Variables
      • Proxy Application Ports
      • OS & Architectures
      • Operations
      • Device API
    • Applications
      • Deploy
      • Secrets
      • Environment variables
      • Substitution (dynamic templates)
      • Volumes
      • Networking
      • Scheduling
      • Registry authentication
      • Using GPUs
      • Tips & Tricks
      • Logs and status
      • Application specification (API reference)
    • Account
      • Personal Access Tokens
      • Service (Robot) Accounts
      • Teams (Share Devices)
    • Monitoring (beta)
      • Device Monitoring
      • Application Monitoring
  • Manage
    • Projects
    • Namespaces
    • Quotas
  • Examples
    • 🏠Home Automation
      • Gladys Assistant
      • Home Assistant
    • 🛠️Preparing OS Images
      • Synpse CLI Builder
      • Build a custom Raspberry Pi image
      • Cloud-init (advanced)
    • 💡Dynamic Templates
    • ☁️Public Cloud IoT
      • AWS IoT Core
      • Azure IoT Hub
      • GCP IoT Core
    • 🚀Device management
      • VNC to remove devices
      • Ansible
  • On-prem Deployment
    • 🐳Docker Compose
    • 🌤️kubernetes
  • Resources
    • API Documentation
    • Deployment patterns
    • Security & Tech
Powered by GitBook
On this page
  • Operating System requirements
  • Supported architectures
  • Windows support

Was this helpful?

  1. synpse core
  2. Devices

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. Enable Docker engine to work with WSL:

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

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

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

PreviousProxy Application PortsNextOperations

Last updated 3 years ago

Was this helpful?

WSL2 ubuntu installed

Docker desktop installed

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

https://docs.microsoft.com/en-us/windows/wsl/install
https://docs.docker.com/desktop/windows/wsl/
microsoft documentation
go FAQ
reddit
Docker engine configuration
Priviledged shell