-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.env
149 lines (120 loc) · 5.88 KB
/
config.env
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# Example configuration.
# Has all configuration variables with default values
# Full documentation can be found here:
# https://docs.syntropystack.com/docs/syntropy-agent-variables
# If using with docker - use `docker run` with key `-e` to set required variable
# Example: docker run -e SYNTROPY_NETWORK_API=docker <...>
# If running agent on bare metal, you can use this script as a base and change it
# to fit your requirements. And use a simple shell script to start agent:
# #!/bin/sh
# set -a # allow all exports
# . ./config.env # import envs (aka config)
# ./syntropy_agent # run the app
# NOTE: Its up to you to use correct paths.
##################################################################################
# Agent Configuration Parameters #
##################################################################################
# Agent authentication token. Mandatory variable.
# Generate your agent token here:
# https://platform-sandbox.syntropystack.com/settings/agent-token
SYNTROPY_AGENT_TOKEN="undefined"
# Agent supports these types of controllers:
# - saas - Software As A Service. Cloud based controller. This is the default
# - script - place configuration files in /etc/syntropy/platform/script/ subdirectory
# This controller is intended for development and debuging.
# - blockchain - substrate blockchain controller.
# Agent supports it but the blockchain controller is still work-in-progress
#SYNTROPY_CONTROLLER_TYPE=saas
# Cloud controller URL
# Don't change this variable unless you really know what and why you are doing.
# SYNTROPY_CONTROLLER_URL=controller-prod-platform-agents.syntropystack.com
# Blockchain controller IPFS URL for configuration JSON files.
# Mandatory field, if blockchain controller is used.
# Value depends on blockchain controller implementation.
#SYNTROPY_IPFS_URL=""
# Owner address for blockchain controller. Default is unset.
#SYNTROPY_OWNER_ADDRESS=""
# Debug log level. Possible values: DEBUG, INFO (default), WARNING, ERROR.
#SYNTROPY_LOG_LEVEL=INFO
# This variable allows changing default Wireguard interfaces MTU
# Changing it may result in network problems.
# Don't touch it unless you know what you are doing.
# 0 (zero) means use default values.
#SYNTROPY_MTU=0
# Agent name as seen in controller.
# Agent names should be unique for the account.
# If this variable is unset - it defaults to OS Hostname.
#SYNTROPY_AGENT_NAME=
# Syntropy provider. Use the integer value for the provider you are using:
#https://docs.syntropystack.com/docs/syntropy-agent-variables#syntropy-provider
# Default value 0 (zero) - try detecting using Geo Location from IP address
# In some cases detection may be inaccurate.
#SYNTROPY_PROVIDER=0
# Freetext, comma separated tags, used as additional information in UI.
# Default is unset
#SYNTROPY_TAGS=""
# Boolean value (true/false) determining whether services shoud be connected automatically.
# Default is disabled - false.
#SYNTROPY_SERVICES_STATUS=false
# Range of open ports for Wireguard interfaces to listen on
# If configured - agent will start wireguard in this port range.
# Use this if there is a firewall or NAT and have some ports opened or port forward enabled.
# Example: SYNTROPY_PORT_RANGE=20000-20055
# Default is unsed and Wireguard will use any free port.
#SYNTROPY_PORT_RANGE=
# Name of Network API
# Possible values: docker, kubernetes, host
# Default is unset - none.
#SYNTROPY_NETWORK_API=
# If using kubernetes Network API, must specify a namespace
#SYNTROPY_NAMESPACE=
# Subnets to allow routing through
# Works only if SYNTROPY_NETWORK_API=host
# Configuration is in JSON format
# Examples:
# SYNTROPY_ALLOWED_IPS=[{"0.0.0.0/0":"internet"}]
# SYNTROPY_ALLOWED_IPS=[{"127.0.24.0/24":"myvpc"},{"192.168.24.0/32":"vpc"}]
# Default is unset
#SYNTROPY_ALLOWED_IPS=
# Location configuration. Float point coordinates.
# Default is unset.
# Configuration example:
#SYNTROPY_LAT=40.14
#SYNTROPY_LON=-74.21
# Work as VPN client if enabled
# Default value false means do not create default route
#VPN_CLIENT=false
# Allows disabling iptables forward rules creation
# Default is enabled. Be sure you know what you are doing before changing it.
#SYNTROPY_CREATE_IPTABLES_RULES=enabled
# Cleanup on leave created Wireguard interfaces and routes on agent exit.
# Default value false means keep created network setup on exit.
#SYNTROPY_CLEANUP_ON_EXIT=false
# Port number on which start prometheus exporter to show peers statistics
# Default value 0 - do not run exporter.
#SYNTROPY_EXPORTER_PORT=0
# Time period in seconds how often check connected peers packet latency and loss
# Valid values 1..60 seconds. Default is 5 seconds.
#SYNTROPY_PEERCHECK_TIME=5
# Window size to calculate moving average of packet loss and latency.
# How many values use for moving average
# This value is like multiplicator for SYNTROPY_PEERCHECK_TIME
# Default value is 24 and with default SYNTROPY_PEERCHECK_TIME
# The time window is 2 minutes: 24 * 5 = 120 seconds = 2 minutes
#SYNTROPY_PEERCHECK_WINDOW=24
# If this value is configured, then routes to services will be deleted
# if packet loss (in percents) is bigger than this configured value
# Default - unset or 0 (zero) value - do not delete routes.
#SYNTROPY_ROUTEDEL_THRESHOLD=
# Dynamic route selection (aka SDN routing) strategy
# speed - oriented at choosing fastest path (all routes are treated equally)
# dr - tries to use public route (direct route) whenever it is possible,
# and fallback to SDN, in case of direct route failure, to keep the connection persistent
# Default strategy is `speed`
#SYNTROPY_ROUTE_STRATEGY=speed
# Websocket connection health check timeout
# (used only when SYNTROPY_CONTROLLER_TYPE=saas)
# During this time ping is expected to be received from the controller
# Timeout is in seconds. If unsed - defaults to 45 seconds.
# NOTE: this parameter is experimental and may be removed in future.
#SYNTROPY_WSS_TIMEOUT=0