The SYNTROPY NETWORK Developer Hub

Welcome to the SYNTROPY NETWORK developer hub. You'll find comprehensive guides and documentation to help you start working with SYNTROPY NETWORK as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Documentation

Install with Pip

Install with Pip

If you are working with Python, we have a package to get started quickly

📘

Python Requirements

Syntropy Agent supports only Python3

Mandatory Variables

In order to successfully install Syntropy with Docker, you must have an API Key

Variable Name

Description

SYNTROPY_API_KEY

SYNTROPY Network Agent Token (String)

👍

API Key Example

SYNTROPY_API_KEY=nQlSAezB8yxncfPPW#$2mKR4UTqEQ2R5


Installation

1. Load Wireguard Module & Install Package

sudo modprobe wireguard 
sudo echo wireguard >> /etc/modules-load.d/wireguard.conf
sudo pip3 install syntropy-agent

2. Create/Edit /etc/systemd/system/syntropy-agent.service.d/10-vars.conf file

[Service]
# Required parameters
Environment=SYNTROPY_API_KEY=<<agent_token>>

3. Create /etc/systemd/system/syntropy-agent.service file:

[Unit]
Description=Syntropy Platform Agent
After=multi-user.target

[Service]
Type=simple
Restart=always
RestartSec=1
ExecStart=/usr/local/bin/syntropy_agent run

[Install]
WantedBy=multi-user.target

4. Start Client

sudo systemctl daemon-reload
sudo systemctl enable --now syntropy-agent

Updated 7 months ago


Next step

Customize your installation with Syntropy Agent Variables

Syntropy Agent Variables

Install with Pip


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.