Syntropy Agent Variables

Below are some of the variables that you can use to configure your installation of the Syntropy Agent.

Mandatory Variables

Variable Name

Description

SYNTROPY_API_KEY

SYNTROPY Network Agent Token (String)

👍

API Key Example

SYNTROPY_API_KEY=nQlSAezB8yxncfPPW#$2mKR4UTqEQ2R5

Optional Variables

Syntropy Controller URL

Variable Name

Description

SYNTROPY_CONTROLLER_URL

Syntropy Controller URL

Possible value: controller-prod-platform-agents.syntropystack.com
Example: SYNTROPY_CONTROLLER_URL=controller-prod-platform-agents.syntropystack.com

Syntropy Agent Name

Variable Namo

Description

SYNTROPY_AGENT_NAME

Syntropy Agent Name

NB: Agent names should be unique for the account.

Syntropy Network API

Variable Name

Description

SYNTROPY_NETWORK_API

Name of Network API

Default value: none
Possible values: docker, kubernetes, host
Example: SYNTROPY_NETWORK_API=docker

Syntropy Namespace

SYNTROPY_NAMESPACE

If using Kubernetes, specify a namespace

Default value: Namespace where agent is deployed
Possible values: namespace names e.g. namespace1 , can be multiple namespaces to read
Example: SYNTROPY_NAMESPACE=namespace1,namespace2

Endpoint Latitude

Variable Name

Description

SYNTROPY_LAT

Latitude of Endpoint

Default value: none
Possible values: coordinates
Example: SYNTROPY_LAT=40.14

Endpoint Longitude

Variable Name

Description

SYNTROPY_LON

Longitude of Endpoint

Default value: none
Possible values: coordinates
Example: SYNTROPY_LON=-74.21

Syntropy Provider

Variable Name

Description

SYNTROPY_PROVIDER

Define the Provider of your endpoint

Use the integer value for the provider you are using

Provider

Value

Example

Amazon Web Services

1

SYNTROPY_PROVIDER=1

Microsoft Azure

2

SYNTROPY_PROVIDER=2

Google Cloud

3

SYNTROPY_PROVIDER=3

Alibaba Cloud

4

SYNTROPY_PROVIDER=4

Oracle Cloud

5

SYNTROPY_PROVIDER=5

DigitalOcean

6

SYNTROPY_PROVIDER=6

Rackspace

7

SYNTROPY_PROVIDER=7

VMware

8

SYNTROPY_PROVIDER=8

IBM Cloud

9

SYNTROPY_PROVIDER=9

Vultr

10

SYNTROPY_PROVIDER=10

HP Enterprise Cloud

11

SYNTROPY_PROVIDER=11

Tencent Cloud

12

SYNTROPY_PROVIDER=12

OVH

13

SYNTROPY_PROVIDER=13

Hetzner

14

SYNTROPY_PROVIDER=14

Liquid Web

15

SYNTROPY_PROVIDER=15

Linode

16

SYNTROPY_PROVIDER=16

Leaseweb

17

SYNTROPY_PROVIDER=17

Dreamhost

18

SYNTROPY_PROVIDER=18

INAP

19

SYNTROPY_PROVIDER=19

a2 Hosting

20

SYNTROPY_PROVIDER=20

Upcloud

21

SYNTROPY_PROVIDER=21

Hivelocity

22

SYNTROPY_PROVIDER=22

Packet

23

SYNTROPY_PROVIDER=23

Selectel

24

SYNTROPY_PROVIDER=24

Logging Level

Variable Name

Description

SYNTROPY_LOG_LEVEL

Definition of Logging Level
Integer or String Values Accepted

Possible Values are as follows:

Type

Value

Example

DEBUG

10

SYNTROPY_LOG_LEVEL=10

INFO

20

SYNTROPY_LOG_LEVEL=20

WARNING

30

SYNTROPY_LOG_LEVEL=30

ERROR

40

SYNTROPY_LOG_LEVEL=40

CRITICAL

50

SYNTROPY_LOG_LEVEL=50

Endpoint Tags

Variable Name

Description

SYNTROPY_TAGS

Endpoint Tag

Default value: none
Possible values: any string
Example: SYNTROPY_TAGS=tag1

Service Status

Variable Name

Description

SYNTROPY_SERVICES_STATUS

Boolean Value determining whether service is enabled or disabled

Default value: false
Possible values: true, false
Example: SYNTROPY_SERVICES_STATUS=true

Port Range

Variable Name

SYNTROPY_PORT_RANGE

Range of open ports for Wireguard to listen on

Possible values: XXXX-XXXX - x any digit.
Example: SYNTROPY_PORT_RANGE=45541-48666

Allowed IPs

Variable Name

SYNTROPY_ALLOWED_IPS

Subnets to allow routing through

  • WORKS ONLY IF SYNTROPY_NETWORK_API='host' *
    Possible values: [{"0.0.0.0/0":"internet"}]
    Example: SYNTROPY_ALLOWED_IPS=[{"127.0.24.0/24":"myvpc"},{"192.168.24.0/32":"vpc"}]

VPN Client setup

Variable Name

VPN_CLIENT

  • SYNTROPY AGENT WORKS AS VPN CLIENT ONLY IF VPN_CLIENT='true'
    Possible values: true
    Example: VPN_CLIENT=true

Maximum Transmission Unit

Variable Name

SYNTROPY_MTU

  • SYNTROPY INTERFACES MTU IS CONFIGURABLE *
    Example: SYNTROPY_MTU=1400

Next step

After you complete Syntropy Agent Installation, it will appear in Endpoint manager. Proceed further to find how you can manage your endpoints.

Did this page help you?