config: add comments about related CLI argument

config.d.ts

@@ -15,23 +15,28 @@ import type {AuthMethod} from '@shared/schema/Auth';
 import type {ClientConnectionSettings} from '@shared/schema/ClientConnectionSettings';
 
 declare const CONFIG: {
+  // CLI argument: --baseuri
   // This URI will prefix all of Flood's HTTP requests.
   // For example, if you intend to serve from http://example.com/flood, set this to
   // '/flood' and configure your web server to pass _all_ requests from `/flood` to
   // the `/flood` of Flood's web server. [default: '/']
   baseURI: string;
 
+  // CLI argument: --dbclean
   // Flood uses a local nedb database to keep track of users, torrents, and activity. The
   // database is regularly purged to remove outdated data. This value dictates how old data
   // is, in milliseconds, before being purged. [default: 1000 * 60 * 60]
   dbCleanInterval: number;
 
+  // CLI argument: --rundir / -d
   // Where to store the local nedb database. [default: '<rundir>/db']
   dbPath: string;
 
+  // CLI argument: --rundir / -d
   // Where to store Flood's temporary files [default: '<rundir>/temp']
   tempPath: string;
 
+  // CLI argument: --auth (--noauth implies --auth=none)
   // Authentication and user management method: [default: 'default']
   //
   // default:
@@ -49,36 +54,44 @@ declare const CONFIG: {
   //  configUser settings will be used.
   authMethod: AuthMethod;
 
+  // CLI arguments: "When auth=none:" group
   // Settings for the no-user configuration.
   configUser: ClientConnectionSettings;
 
+  // CLI argument: --host / -h
   // The host that Flood should listen for web connections on.
   // To listen on all interfaces, change to `floodServerHost: '0.0.0.0'`. [default: '127.0.0.1']
   floodServerHost: string;
 
+  // CLI argument: --port / -p
   // The port that Flood should listen for web connections on. [default: 3000]
   floodServerPort: number;
 
+  // CLI argument: --proxy
   // Used for development only. Not used in production.
   // See the "Local Development" section of README.md for detail.
   floodServerProxy: string;
 
+  // CLI argument: --maxhistorystates
   // Flood keeps a history of torrent download and upload speeds.
   // This value dictates the number of individual records per period to keep.
   maxHistoryStates: number;
 
+  // CLI argument: --clientpoll
   // How often (in milliseconds) Flood will request the torrent list. This value affects how
   // often values are updated when a user is present. {torrentClientPollIntervalIdle} will be
   // used when no user is present. Note that poll intervals only affect activity stream. API
   // requests like "GET /api/torrents" always trigger fresh torrent list fetch. [default: 1000 * 2]
   torrentClientPollInterval: number;
 
+  // CLI argument: --clientpollidle
   // How often (in milliseconds) Flood will request the torrent list when no user is present.
   // {torrentClientPollInterval} will be used when at least one user is present. This value
   // usually affects some automations such as notification of download completion. Automations
   // that rely on torrent properties may be delayed within the interval. [default: 1000 * 60 * 15]
   torrentClientPollIntervalIdle: number;
 
+  // CLI argument: --secret / -s
   // A unique secret for signing messages with JWT (see https://jwt.io).
   // Change this to something unique and hard to guess.
   // You can use 'uuidgen' or 'cat /proc/sys/kernel/random/uuid' or 'uuidgenerator.net'.
@@ -86,12 +99,15 @@ declare const CONFIG: {
   // Generated secret is stored to "<rundir>/flood.secret" with 0600 permissions.
   secret: string;
 
+  // CLI argument: --ssl
   // Configuration for SSL, if using SSL with the Flood service directly. [default: false]
   ssl: boolean;
 
+  // CLI argument: --sslkey
   // Path to the SSL private key. [default: '<rundir>/key.pem']
   sslKey: string;
 
+  // CLI argument: --sslcert
   // Path to the SSL fullchain certificate. [default: '<rundir>/fullchain.pem']
   sslCert: string;
 
@@ -99,6 +115,7 @@ declare const CONFIG: {
   // "undefined" means all possible mounts. [default: undefined]
   watchMountPoints?: Array<string>;
 
+  // CLI argument: --allowedpath, can be called multiple times
   // Allowed paths for file operations. "undefined" means everything. [default: undefined]
   allowedPaths?: Array<string>;
 };