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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
// Package atlas runs the Atlas server.
package atlas
import (
"fmt"
"reflect"
"strconv"
"strings"
"time"
"github.com/rs/zerolog"
)
// Config contains the configuration for Atlas. The env struct tag contains the
// environment variable name and the default value if missing, or empty (if not
// ?=). All string arrays are comma-separated.
type Config struct {
// The addresses to listen on (comma-separated).
Addr []string `env:"ATLAS_ADDR?=:8081"`
// The addresses to listen on with TLS (comma-separated).
AddrTLS []string `env:"ATLAS_ADDR_HTTPS"`
// Whether to trust Cloudflare headers like CF-Connecting-IP.
//
// This is not safe to use unless you:
// - Set Host to prevent it from being accessed via other CF zones.
// - Use an IP whitelist, or client certificates with mTLS-only origin pull.
Cloudflare bool `env:"ATLAS_CLOUDFLARE"`
// Comma-separated list of case-insensitive hostnames to accept via the Host
// header. If not provided, all hostnames are allowed.
Host []string `env:"ATLAS_HOST"`
// Comma-separated list of paths to SSL server certificates to use for SSL.
// The .crt and .key extensions will be appended automatically. If not
// provided, SSL is disabled.
ServerCerts []string `env:"ATLAS_SERVER_CERTS"`
// Comma-separated list of paths to SSL CA certificates to use for SSL
// client authentication. No effect is ServerCerts is not provided. If not
// provided, clients are not required to use SSL client authentication.
// TODO: ClientCerts []string `env:"ATLAS_CLIENT_CERTS"`
// The minimum log level (e.g., trace, debug, info, warn, error, fatal).
//
// Note that access logs for noisy HTTP endpoints are demoted to debug.
LogLevel zerolog.Level `env:"ATLAS_LOG_LEVEL=debug"`
// Whether to log to stdout.
LogStdout bool `env:"ATLAS_LOG_STDOUT=true"`
// Whether to use pretty logs.
LogStdoutPretty bool `env:"ATLAS_LOG_STDOUT_PRETTY=true"`
// The minimum log level for stdout.
LogStdoutLevel zerolog.Level `env:"ATLAS_LOG_STDOUT_LEVEL=trace"`
// The log file to output to, if provided. Reopened on SIGHUP.
LogFile string `env:"ATLAS_LOG_FILE"`
// The minimum log level for the log file.
LogFileLevel zerolog.Level `env:"ATLAS_LOG_FILE_LEVEL=info"`
// Maps source IP prefixes to another IP (useful for controlling server
// registration IPs when running within a LAN and port forwarding during
// development). Comma-separated list of prefix=ip (example:
// 192.168.0.0/24=1.2.3.4).
DevMapIP []string `env:"ATLAS_DEV_MAP_IP"`
// The maximum number of gameservers to allow. If -1, no limit is applied.
API0_MaxServers int `env:"ATLAS_API0_MAX_SERVERS=1000"`
// The maximum number of gameservers to allow per IP. If -1, no limit is
// applied.
API0_MaxServersPerIP int `env:"ATLAS_API0_MAX_SERVERS_PER_IP=25"`
// The amount of time for player masterserver auth tokens to be valid for.
API0_TokenExpiryTime time.Duration `env:"ATLAS_API0_TOKEN_EXPIRY_TIME=24h"`
// Don't check player masterserver auth tokens, disable stryder auth.
API0_InsecureDevNoCheckPlayerAuth bool `env:"ATLAS_API0_INSECURE_DEV_NO_CHECK_PLAYER_AUTH"`
// Whether to allow games to register via IPv6. Not recommended.
API0_AllowGameServerIPv6 bool `env:"ATLAS_API0_ALLOW_GAME_SERVER_IPV6"`
// Minimum launcher semver to allow for servers or authenticated clients.
// Dev versions are always allowed. If not provided, all client versions are
// allowed.
API0_MinimumLauncherVersion string `env:"ATLAS_API0_MINIMUM_LAUNCHER_VERSION"`
// The time after registration for a gameserver to complete verification by.
API0_ServerList_VerifyTime time.Duration `env:"ATLAS_API0_SERVERLIST_VERIFY_TIME=10s"`
// The time since the last heartbeat for a gameserver to be marked as
// dead.
API0_ServerList_DeadTime time.Duration `env:"ATLAS_API0_SERVERLIST_DEAD_TIME=30s"`
// The time since the last heartbeat for a gameserver to be discarded (i.e.,
// it can't be added again without re-verifying).
API0_ServerList_GhostTime time.Duration `env:"ATLAS_API0_SERVERLIST_GHOST_TIME=2m"`
// The storage to use for accounts:
// - memory
// - sqlite3:/path/to/atlas.db
API0_Storage_Accounts string `env:"ATLAS_API0_STORAGE_ACCOUNTS=memory"`
// The storage to use for pdata:
// - memory:compress
// - sqlite3:/path/to/pdata.db
API0_Storage_Pdata string `env:"ATLAS_API0_STORAGE_PDATA=memory:compress"`
// The source to use for mainmenupromos:
// - none
// - file:/path/to/mainmenupromos.json
API0_MainMenuPromos string `env:"ATLAS_API0_MAINMENUPROMOS=none"`
// The email address to use for Origin login. If not provided, usernames are not
// resolved during authentication.
OriginEmail string `env:"ATLAS_ORIGIN_EMAIL"`
// The password for Origin login.
OriginPassword string `env:"ATLAS_ORIGIN_PASSWORD"`
// The JSON file to save Origin login info to so tokens are preserved across
// restarts. Highly recommended.
OriginPersist string `env:"ATLAS_ORIGIN_PERSIST"`
// Secret token for accessing internal metrics.
MetricsSecret string `env:"ATLAS_METRICS_SECRET"`
// The path to use for static website files. If a file named redirects.json
// exists, it is read at startup, reloaded on SIGHUP, and used as a mapping
// of top-level names to URLs.
Web string `env:"ATLAS_WEB="`
// For sd-notify.
NotifySocket string `env:"NOTIFY_SOCKET"`
// TODO: BadWords
}
// UnmarshalEnv unmarshals an array of environment variables into c, setting
// default values as appropriate. If incremental is true, default values will
// not be set for missing env vars, but only for empty ones.
func (c *Config) UnmarshalEnv(es []string, incremental bool) error {
em := map[string]string{}
for _, e := range es {
if strings.HasPrefix(e, "ATLAS_") || strings.HasPrefix(e, "NOTIFY_SOCKET=") {
if k, v, ok := strings.Cut(e, "="); ok {
em[k] = v
}
}
}
cv := reflect.ValueOf(c).Elem()
for _, ctf := range reflect.VisibleFields(cv.Type()) {
env, ok := ctf.Tag.Lookup("env")
if !ok {
continue
}
var unsettable bool
key, val, _ := strings.Cut(env, "=")
if strings.HasSuffix(key, "?") {
key = strings.TrimSuffix(key, "?")
unsettable = true
}
if v, exists := em[key]; exists {
if unsettable || v != "" {
val = v
}
delete(em, key)
} else if incremental {
continue
}
switch cvf := cv.FieldByName(ctf.Name); cvf.Interface().(type) {
case string:
cvf.SetString(val)
case int, int8, int16, int32, int64:
if val == "" {
cvf.SetInt(0)
} else if v, err := strconv.ParseInt(val, 10, 64); err == nil {
cvf.SetInt(v)
} else {
return fmt.Errorf("env %s (%T): parse %q: %w", key, cvf.Interface(), val, err)
}
case bool:
if val == "" {
cvf.SetBool(false)
} else if v, err := strconv.ParseBool(val); err == nil {
cvf.SetBool(v)
} else {
return fmt.Errorf("env %s (%T): parse %q: %w", key, cvf.Interface(), val, err)
}
case []string:
if val == "" {
cvf.Set(reflect.ValueOf([]string{}))
} else {
cvf.Set(reflect.ValueOf(strings.Split(val, ",")))
}
case zerolog.Level:
if v, err := zerolog.ParseLevel(val); err == nil {
cvf.Set(reflect.ValueOf(v))
} else {
return fmt.Errorf("env %s (%T): parse %q: %w", key, cvf.Interface(), val, err)
}
case time.Duration:
if v, err := time.ParseDuration(val); err == nil {
cvf.Set(reflect.ValueOf(v))
} else {
return fmt.Errorf("env %s (%T): parse %q: %w", key, cvf.Interface(), val, err)
}
default:
return fmt.Errorf("unhandled type %T (%s)", cvf.Interface(), env)
}
}
for key, val := range em {
if val != "" {
return fmt.Errorf("unknown environment variable %q", key)
}
}
return nil
}
|