Merge branch 'v1.1-dev' as v1.1.0
[websub-hub] / config / default.js
1 'use strict';
2
3 // Provide default values for all configuration.
4
5 const packageName = require('../package.json').name;
6 const common = require('../src/common');
7
8 const defaultOptions = {
9 // Uniquely identify this instance, used to tag work-in-progress.
10 nodeId: common.requestId(), // Default to ephemeral ID: easiest for clustered deployments.
11
12 // Dingus API Server Framework options. Be sure to set the one REQUIRED option here.
13 dingus: {
14 // This needs to be the full externally accessible root URL, including any proxyPrefix component, which clients will connect to, and which topics will list as their hub link.
15 selfBaseUrl: '', // REQUIRED
16
17 // trustProxy: true, // If true, trust values of some headers regarding client IP address and protocol.
18 proxyPrefix: '', // Leading path parts to ignore when parsing routes, and include when constructing links, e.g. /hub
19 },
20
21 // Database options
22 db: {
23 connectionString: '', // e.g. sqlite://path/to/dbfile.sqlite
24 queryLogLevel: undefined, // Set to log queries
25 cacheEnabled: true, // Cache some db responses. (Postgres only)
26 listener: { // Settings for the cache-invalidator connection. (Postgres only)
27 // pingDelayMs: 5000, // Connection keep-alive/health-check.
28 // reconnectDelayMs: 6000, // Wait time before attempting reconnection.
29 // reconnectTimes: 10, // Retries limit.
30 },
31 },
32
33 // Logging options
34 logger: {
35 ignoreBelowLevel: 'info',
36 },
37
38 // Lease time limits, if not specified per-topic. Comments are defaults in code.
39 topicLeaseDefaults: {
40 // leaseSecondsPreferred: 86400 * 10,
41 // leaseSecondsMin: 86400 * 1,
42 // leaseSecondsMax: 86400 * 365,
43 },
44
45 manager: {
46 pageTitle: packageName, // title on html pages
47 strictSecrets: false, // If true, reject requests with secrets but not over https
48 publicHub: true, // Accept publish requests as new topics.
49 processImmediately: true, // If true, immediately attempt to process requests when accepted.
50 },
51
52 communication: {
53 strictTopicHubLink: true, // If true, deletes topics which do not list us (dingus.selfBaseUrl) as a hub relation.
54 retryBackoffSeconds: [60, 120, 360, 1440, 7200, 43200, 86400], // failed requests retry according to number of attempts
55 claimTimeoutSeconds: 600, // how long until an in-progress task is deemed abandoned
56 },
57
58 // Outgoing request UA header. Comments are defaults in code.
59 userAgent: {
60 // product: packageName,
61 // version: packageVersion,
62 // implementation: Enum.Specification,
63 },
64
65 authenticator: {
66 basicRealm: packageName, // Realm prompt for login on administration pages
67 secureAuthOnly: true, // Require secure transport for authentication.
68 },
69
70 worker: {
71 concurrency: 10, // maximum number of tasks to process at once
72 pollingEnabled: true, // periodically check for new tasks
73 recurrSleepMs: 60000, // check this often
74 },
75
76 };
77
78 module.exports = defaultOptions;