-
Notifications
You must be signed in to change notification settings - Fork 554
/
config.ts
485 lines (440 loc) · 13 KB
/
config.ts
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
import path from 'node:path'
import assert from 'node:assert'
import { DAY, HOUR, SECOND } from '@atproto/common'
import { Customization } from '@atproto/oauth-provider'
import { ServerEnvironment } from './env'
// off-config but still from env:
// logging: LOG_LEVEL, LOG_SYSTEMS, LOG_ENABLED, LOG_DESTINATION
export const envToCfg = (env: ServerEnvironment): ServerConfig => {
const port = env.port ?? 2583
const hostname = env.hostname ?? 'localhost'
const publicUrl =
hostname === 'localhost'
? `http://localhost:${port}`
: `https://${hostname}`
const did = env.serviceDid ?? `did:web:${hostname}`
const serviceCfg: ServerConfig['service'] = {
port,
hostname,
publicUrl,
did,
version: env.version, // default?
privacyPolicyUrl: env.privacyPolicyUrl,
termsOfServiceUrl: env.termsOfServiceUrl,
contactEmailAddress: env.contactEmailAddress,
acceptingImports: env.acceptingImports ?? true,
blobUploadLimit: env.blobUploadLimit ?? 5 * 1024 * 1024, // 5mb
devMode: env.devMode ?? false,
}
const dbLoc = (name: string) => {
return env.dataDirectory ? path.join(env.dataDirectory, name) : name
}
const disableWalAutoCheckpoint = env.disableWalAutoCheckpoint ?? false
const dbCfg: ServerConfig['db'] = {
accountDbLoc: env.accountDbLocation ?? dbLoc('account.sqlite'),
sequencerDbLoc: env.sequencerDbLocation ?? dbLoc('sequencer.sqlite'),
didCacheDbLoc: env.didCacheDbLocation ?? dbLoc('did_cache.sqlite'),
disableWalAutoCheckpoint,
}
const actorStoreCfg: ServerConfig['actorStore'] = {
directory: env.actorStoreDirectory ?? dbLoc('actors'),
cacheSize: env.actorStoreCacheSize ?? 100,
disableWalAutoCheckpoint,
}
let blobstoreCfg: ServerConfig['blobstore']
if (env.blobstoreS3Bucket && env.blobstoreDiskLocation) {
throw new Error('Cannot set both S3 and disk blobstore env vars')
}
if (env.blobstoreS3Bucket) {
blobstoreCfg = {
provider: 's3',
bucket: env.blobstoreS3Bucket,
uploadTimeoutMs: env.blobstoreS3UploadTimeoutMs || 20000,
region: env.blobstoreS3Region,
endpoint: env.blobstoreS3Endpoint,
forcePathStyle: env.blobstoreS3ForcePathStyle,
}
if (env.blobstoreS3AccessKeyId || env.blobstoreS3SecretAccessKey) {
if (!env.blobstoreS3AccessKeyId || !env.blobstoreS3SecretAccessKey) {
throw new Error(
'Must specify both S3 access key id and secret access key blobstore env vars',
)
}
blobstoreCfg.credentials = {
accessKeyId: env.blobstoreS3AccessKeyId,
secretAccessKey: env.blobstoreS3SecretAccessKey,
}
}
} else if (env.blobstoreDiskLocation) {
blobstoreCfg = {
provider: 'disk',
location: env.blobstoreDiskLocation,
tempLocation: env.blobstoreDiskTmpLocation,
}
} else {
throw new Error('Must configure either S3 or disk blobstore')
}
let serviceHandleDomains: string[]
if (env.serviceHandleDomains && env.serviceHandleDomains.length > 0) {
serviceHandleDomains = env.serviceHandleDomains
} else {
if (hostname === 'localhost') {
serviceHandleDomains = ['.test']
} else {
serviceHandleDomains = [`.${hostname}`]
}
}
const invalidDomain = serviceHandleDomains.find(
(domain) => domain.length < 1 || !domain.startsWith('.'),
)
if (invalidDomain) {
throw new Error(`Invalid handle domain: ${invalidDomain}`)
}
const identityCfg: ServerConfig['identity'] = {
plcUrl: env.didPlcUrl ?? 'https://plc.directory',
cacheMaxTTL: env.didCacheMaxTTL ?? DAY,
cacheStaleTTL: env.didCacheStaleTTL ?? HOUR,
resolverTimeout: env.resolverTimeout ?? 3 * SECOND,
recoveryDidKey: env.recoveryDidKey ?? null,
serviceHandleDomains,
handleBackupNameservers: env.handleBackupNameservers,
enableDidDocWithSession: !!env.enableDidDocWithSession,
}
let entrywayCfg: ServerConfig['entryway'] = null
if (env.entrywayUrl) {
assert(
env.entrywayJwtVerifyKeyK256PublicKeyHex &&
env.entrywayPlcRotationKey &&
env.entrywayDid,
'if entryway url is configured, must include all required entryway configuration',
)
entrywayCfg = {
url: env.entrywayUrl,
did: env.entrywayDid,
jwtPublicKeyHex: env.entrywayJwtVerifyKeyK256PublicKeyHex,
plcRotationKey: env.entrywayPlcRotationKey,
}
}
// default to being required if left undefined
const invitesCfg: ServerConfig['invites'] =
env.inviteRequired === false
? {
required: false,
}
: {
required: true,
interval: env.inviteInterval ?? null,
epoch: env.inviteEpoch ?? 0,
}
let emailCfg: ServerConfig['email']
if (!env.emailFromAddress && !env.emailSmtpUrl) {
emailCfg = null
} else {
if (!env.emailFromAddress || !env.emailSmtpUrl) {
throw new Error(
'Partial email config, must set both emailFromAddress and emailSmtpUrl',
)
}
emailCfg = {
smtpUrl: env.emailSmtpUrl,
fromAddress: env.emailFromAddress,
}
}
let moderationEmailCfg: ServerConfig['moderationEmail']
if (!env.moderationEmailAddress && !env.moderationEmailSmtpUrl) {
moderationEmailCfg = null
} else {
if (!env.moderationEmailAddress || !env.moderationEmailSmtpUrl) {
throw new Error(
'Partial moderation email config, must set both emailFromAddress and emailSmtpUrl',
)
}
moderationEmailCfg = {
smtpUrl: env.moderationEmailSmtpUrl,
fromAddress: env.moderationEmailAddress,
}
}
const subscriptionCfg: ServerConfig['subscription'] = {
maxBuffer: env.maxSubscriptionBuffer ?? 500,
repoBackfillLimitMs: env.repoBackfillLimitMs ?? DAY,
}
let bskyAppViewCfg: ServerConfig['bskyAppView'] = null
if (env.bskyAppViewUrl) {
assert(
env.bskyAppViewDid,
'if bsky appview service url is configured, must configure its did as well.',
)
bskyAppViewCfg = {
url: env.bskyAppViewUrl,
did: env.bskyAppViewDid,
cdnUrlPattern: env.bskyAppViewCdnUrlPattern,
}
}
let modServiceCfg: ServerConfig['modService'] = null
if (env.modServiceUrl) {
assert(
env.modServiceDid,
'if mod service url is configured, must configure its did as well.',
)
modServiceCfg = {
url: env.modServiceUrl,
did: env.modServiceDid,
}
}
let reportServiceCfg: ServerConfig['reportService'] = null
if (env.reportServiceUrl) {
assert(
env.reportServiceDid,
'if report service url is configured, must configure its did as well.',
)
reportServiceCfg = {
url: env.reportServiceUrl,
did: env.reportServiceDid,
}
}
// if there's a mod service, default report service into it
if (modServiceCfg && !reportServiceCfg) {
reportServiceCfg = modServiceCfg
}
const redisCfg: ServerConfig['redis'] = env.redisScratchAddress
? {
address: env.redisScratchAddress,
password: env.redisScratchPassword,
}
: null
const rateLimitsCfg: ServerConfig['rateLimits'] = env.rateLimitsEnabled
? {
enabled: true,
mode: redisCfg !== null ? 'redis' : 'memory',
bypassKey: env.rateLimitBypassKey,
bypassIps: env.rateLimitBypassIps?.map((ipOrCidr) =>
ipOrCidr.split('/')[0]?.trim(),
),
}
: { enabled: false }
const crawlersCfg: ServerConfig['crawlers'] = env.crawlers ?? []
const fetchCfg: ServerConfig['fetch'] = {
disableSsrfProtection: env.disableSsrfProtection ?? env.devMode ?? false,
maxResponseSize: env.fetchMaxResponseSize ?? 512 * 1024, // 512kb
}
const proxyCfg: ServerConfig['proxy'] = {
disableSsrfProtection: env.disableSsrfProtection ?? env.devMode ?? false,
allowHTTP2: env.proxyAllowHTTP2 ?? false,
headersTimeout: env.proxyHeadersTimeout ?? 10e3,
bodyTimeout: env.proxyBodyTimeout ?? 30e3,
maxResponseSize: env.proxyMaxResponseSize ?? 10 * 1024 * 1024, // 10mb
preferCompressed: env.proxyPreferCompressed ?? false,
}
const oauthCfg: ServerConfig['oauth'] = entrywayCfg
? {
issuer: entrywayCfg.url,
provider: false,
}
: {
issuer: serviceCfg.publicUrl,
provider: {
customization: {
name: env.serviceName ?? 'Personal PDS',
logo: env.logoUrl,
colors: {
brand: env.brandColor,
error: env.errorColor,
warning: env.warningColor,
},
links: [
{
title: 'Home',
href: env.homeUrl,
rel: 'bookmark',
},
{
title: 'Terms of Service',
href: env.termsOfServiceUrl,
rel: 'terms-of-service',
},
{
title: 'Privacy Policy',
href: env.privacyPolicyUrl,
rel: 'privacy-policy',
},
{
title: 'Support',
href: env.supportUrl,
rel: 'help',
},
].filter(
(f): f is typeof f & { href: NonNullable<(typeof f)['href']> } =>
f.href != null,
),
},
},
}
return {
service: serviceCfg,
db: dbCfg,
actorStore: actorStoreCfg,
blobstore: blobstoreCfg,
identity: identityCfg,
entryway: entrywayCfg,
invites: invitesCfg,
email: emailCfg,
moderationEmail: moderationEmailCfg,
subscription: subscriptionCfg,
bskyAppView: bskyAppViewCfg,
modService: modServiceCfg,
reportService: reportServiceCfg,
redis: redisCfg,
rateLimits: rateLimitsCfg,
crawlers: crawlersCfg,
fetch: fetchCfg,
proxy: proxyCfg,
oauth: oauthCfg,
}
}
export type ServerConfig = {
service: ServiceConfig
db: DatabaseConfig
actorStore: ActorStoreConfig
blobstore: S3BlobstoreConfig | DiskBlobstoreConfig
identity: IdentityConfig
entryway: EntrywayConfig | null
invites: InvitesConfig
email: EmailConfig | null
moderationEmail: EmailConfig | null
subscription: SubscriptionConfig
bskyAppView: BksyAppViewConfig | null
modService: ModServiceConfig | null
reportService: ReportServiceConfig | null
redis: RedisScratchConfig | null
rateLimits: RateLimitsConfig
crawlers: string[]
fetch: FetchConfig
proxy: ProxyConfig
oauth: OAuthConfig
}
export type ServiceConfig = {
port: number
hostname: string
publicUrl: string
did: string
version?: string
privacyPolicyUrl?: string
termsOfServiceUrl?: string
acceptingImports: boolean
blobUploadLimit: number
contactEmailAddress?: string
devMode: boolean
}
export type DatabaseConfig = {
accountDbLoc: string
sequencerDbLoc: string
didCacheDbLoc: string
disableWalAutoCheckpoint: boolean
}
export type ActorStoreConfig = {
directory: string
cacheSize: number
disableWalAutoCheckpoint: boolean
}
export type S3BlobstoreConfig = {
provider: 's3'
bucket: string
region?: string
endpoint?: string
forcePathStyle?: boolean
uploadTimeoutMs?: number
credentials?: {
accessKeyId: string
secretAccessKey: string
}
}
export type DiskBlobstoreConfig = {
provider: 'disk'
location: string
tempLocation?: string
}
export type IdentityConfig = {
plcUrl: string
resolverTimeout: number
cacheStaleTTL: number
cacheMaxTTL: number
recoveryDidKey: string | null
serviceHandleDomains: string[]
handleBackupNameservers?: string[]
enableDidDocWithSession: boolean
}
export type EntrywayConfig = {
url: string
did: string
jwtPublicKeyHex: string
plcRotationKey: string
}
export type FetchConfig = {
disableSsrfProtection: boolean
maxResponseSize: number
}
export type ProxyConfig = {
disableSsrfProtection: boolean
allowHTTP2: boolean
headersTimeout: number
bodyTimeout: number
maxResponseSize: number
/**
* When proxying requests that might get intercepted (for read-after-write) we
* negotiate the encoding based on the client's preferences. We will however
* use or own weights in order to be able to better control if the PDS will
* need to perform content decoding. This settings allows to prefer compressed
* content over uncompressed one.
*/
preferCompressed: boolean
}
export type OAuthConfig = {
issuer: string
provider:
| false
| {
customization: Customization
}
}
export type InvitesConfig =
| {
required: true
interval: number | null
epoch: number
}
| {
required: false
}
export type EmailConfig = {
smtpUrl: string
fromAddress: string
}
export type SubscriptionConfig = {
maxBuffer: number
repoBackfillLimitMs: number
}
export type RedisScratchConfig = {
address: string
password?: string
}
export type RateLimitsConfig =
| {
enabled: true
mode: 'memory' | 'redis'
bypassKey?: string
bypassIps?: string[]
}
| { enabled: false }
export type BksyAppViewConfig = {
url: string
did: string
cdnUrlPattern?: string
}
export type ModServiceConfig = {
url: string
did: string
}
export type ReportServiceConfig = {
url: string
did: string
}