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
  • What are devices in Synpse?
  • Installing the agent on your device
  • Device Registration Tokens
  • Configuration file

Was this helpful?

  1. synpse core
  2. Devices

Device Provisioning

Devices in Synpse are responsible for running your applications.

PreviousDevicesNextHTTPS Tunnel Access

Last updated 3 years ago

Was this helpful?

What are devices in Synpse?

Devices in Synpse are like virtual machines in your favourite cloud provider. You will need at least one device that is online to run your applications. There's no limit on the number of applications that can be started on a single device, it depends on the available CPU and RAM.

Once device is registered to a project, you will be able to:

  • SSH into the device

  • Deploy applications to the device

  • View device resource (CPU/RAM/Disk) utilization

Installing the agent on your device

For installation instructions, please refer to the of the documentation.

Device Registration Tokens

All projects are created with a default registration token. However, it's often required to create new registration tokens with specific limits or just with new environment variables or labels. To create a new token, go to the "provisioning" page and click on "create registration token":

Once the device registration token is created, click "Provision Device" and select the token:

This command will:

  1. Download the synpse agent to the device

  2. Install it and supply the registration details

Once you run the command, you should be able to see the device in your devices page:

Configuration file

In cases where systemd is not available or other type of process supervisor is used manual agent configuration might be needed.

Synpse agent when starting will look for configuration file config.yaml in default location /etc/synpse (can be changed using AGENT_CONFIG_DIR variable).

Config file example:

---
agent:
  controllerURI: http://cloud.synpse.com/api
  project: prj_1u4dQL6qYFGMkhmcKJPt93gYUUU
  registrationToken: drt_1u4dQMx57tzIo7K62gKqve4HHHH

Download latest agent:

curl https://downloads.synpse.net/agent/linux/amd64/latest/agent -o /usr/local/bin/synpse-agent
install section
registered device view