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

Was this helpful?

  1. Agent
  2. Install

Configuration

Agent can be configured using environment variables. Variables are outlines bellow:

AGENT_PROJECT: Agent project ID.
AGENT_REGISTRATION_TOKEN: Agent registration token.
AGENT_DOWNLOAD_URL_BASE: Base URL used by the agent to download necessary binaries or updates.
AGENT_CONFIG_DIR: Directory where the agent’s configuration files are stored.
AGENT_STATE_DIR: Directory used for storing the agent’s state.
AGENT_LOGS_DIR: Directory where the agent’s log files are written.
AGENT_LOG_LEVEL: Logging level for the agent (e.g., info, debug).
AGENT_PID_FILE: File path where the agent's process ID (PID) is stored.
AGENT_DOCKER_RUNTIME_DISABLED: When set to true, disables the Docker runtime, preventing the agent from executing containers using Docker.
AGENT_EXEC_RUNTIME_DISABLED: When set to true, disables the exec runtime, preventing the agent from executing containers using the exec runtime.
AGENT_IMAGE_GC_AGE: Duration after which unused images are garbage collected (e.g., 48h).
AGENT_IMAGE_GC_FORCE: If true, forces garbage collection of images regardless of state.
AGENT_INFO_REFRESH_INTERVAL: Interval at which the agent refreshes its own information (e.g., 1m).
AGENT_ENABLE_LOCAL_METRICS_ENDPOINT: When true, enables a local endpoint for metrics exposure.
AGENT_SUPERVISOR_REFRESH_INTERVAL: Interval at which the supervisor is refreshed. Note that setting this too low may cause duplicate event emissions due to timing issues.
AGENT_ENABLE_LOCAL_SSH: When true, enables local SSH functionality.
PreviousContainerized agentNextUninstall

Last updated 4 months ago

Was this helpful?