View .md

FeatherWings config.yml reference

All 191 FeatherWings configuration keys with type, default and description, generated from the Wings source (config.go).

Last synced from FeatherWings dc70814 on .

On this page

About the file

  • Location: /etc/featherpanel/config.yml. Override it with featherwings --config <path>.
  • You normally do not write it by hand. featherwings configure --join-data … writes it from the panel (see Configuration), and the panel can push changes to a running node unless ignore_panel_config_updates is true.
  • Keys are YAML, nested with dots below. A few keys keep their Go spelling (BlockBaseDirMount, Search); write them exactly as shown.
  • Defaults come from the default: struct tags. An empty default means the Go zero value (false, 0 or empty).
  • Error reporting (sentry) is enabled by default and sends crash reports to MythicalSystems' GlitchTip. Set sentry.enabled: false to turn it off.
  • With api.docs.enabled (default true) Wings serves Swagger UI at /api/docs and the spec at /api/docs/openapi.json.

Keys

Top-level keys

KeyTypeDefaultDescription
debugboolDetermines if wings should be running in debug mode. This value is ignored if the debug flag is passed through the command line arguments.
quietboolDetermines if wings should run with minimal logging output. This value is ignored if debug mode is enabled.
app_namestringFeatherPanel
uuidstringA unique identifier for this node in the Panel.
token_idstringAn identifier for the token which must be included in any requests to the panel so that the token can be looked up correctly.
tokenstringThe token used when performing operations. Requests to this instance must validate against it.
remotestringThe location where the panel is running that this daemon should connect to to collect data and send events.
allowed_mounts[]stringAllowedMounts is a list of allowed host-system mount points. This is required to have the "Server Mounts" feature work properly.
BlockBaseDirMountbooltrueBlockBaseDirMount indicates whether mounting to /home/container is blocked. If true, mounting to /home/container is blocked. If false, mounting to /home/container is allowed.
allowed_origins[]stringAllowedOrigins is a list of allowed request origins. The Panel URL is automatically allowed, this is only needed for adding additional origins.
allow_cors_private_networkboolAllowCORSPrivateNetwork sets the `Access-Control-Request-Private-Network` header which allows client browsers to make requests to internal IP addresses over HTTP. This setting is only required by users running Wings without SSL certificates and using internal IP addresses in order to connect. Most users should NOT enable this setting.
ignore_panel_config_updatesboolIgnorePanelConfigUpdates causes confiuration updates that are sent by the panel to be ignored.

api

KeyTypeDefaultDescription
apiobjectApiConfiguration defines the configuration for the internal API that is exposed by the Wings webserver.
api.hoststring0.0.0.0The interface that the internal webserver should bind to.
api.portint8080The port that the internal webserver should bind to.
api.docsobjectDocs controls whether the auto-generated Swagger/OpenAPI documentation is served.
api.docs.enabledbooltrue
api.sslobjectSSL configuration for the daemon.
api.ssl.enabledbool
api.ssl.certstring
api.ssl.keystring
api.disable_remote_downloadboolDetermines if functionality for allowing remote download of files into server directories is enabled on this instance. If set to "true" remote downloads will not be possible for servers.
api.remote_downloadobjectRemoteDownload defines settings specific to server remote file downloads.
api.remote_download.max_redirectsint10MaxRedirects specifies the maximum number of HTTP redirects to follow during a remote file download. Defaults to 10.
api.remote_download_allowlist[]stringRemoteDownloadAllowlist allows remote downloads of files into server directories to connect to otherwise blocked private/internal destinations. Entries may be hostnames, IP addresses, or CIDR ranges.
api.upload_limitint64100The maximum size for files uploaded through the Panel in MiB.
api.trusted_proxies[]stringA list of IP address of proxies that may send a X-Forwarded-For header to set the true clients IP
api.ignore_certificate_errorsboolIf set to true, TLS certificate verification errors will be ignored when making API calls to the Panel. This is useful for development environments with self-signed certificates. The command line flag --ignore-certificate-errors takes precedence.

system

KeyTypeDefaultDescription
systemobjectSystemConfiguration defines basic system configuration settings.
system.check_install_exit_codeboolfalseCheckInstallExitCode marks a server installation as failed when the install script exits with a non-zero code, or the container wait reports an error. It is disabled by default to keep the historic behaviour, where every installation that ran to completion was reported to the Panel as successful.
system.root_directorystring/var/lib/featherpanelThe root directory where all of the featherpanel data is stored at.
system.log_directorystring/var/log/featherpanelDirectory where logs for server installations and other wings events are logged.
system.datastring/var/lib/featherpanel/volumesDirectory where the server data is stored at.
system.archive_directorystring/var/lib/featherpanel/archivesDirectory where server archives for transferring will be stored.
system.backup_directorystring/var/lib/featherpanel/backupsDirectory where local backups will be stored on the machine.
system.node_backup_directorystring/var/lib/featherpanel/wings_backupDirectory where whole-node Wings backups are stored (outside volumes so they are not exposed over SFTP).
system.diffs_directorystring/var/lib/featherpanel/diffsDirectory where per-server file revision databases are stored.
system.tmp_directorystring/tmp/featherpanelTmpDirectory specifies where temporary files for featherpanel installation processes should be created. This supports environments running docker-in-docker.
system.usernamestringfeatherpanelThe user that should own all of the server files, and be used for containers.
system.timezonestringThe timezone for this Wings instance. This is detected by Wings automatically if possible, and falls back to UTC if not able to be detected. If you need to set this manually, that can also be done. This timezone value is passed into all containers created by Wings.
system.userobjectDefinitions for the user that gets created to ensure that we can quickly access this information without constantly having to do a system lookup.
system.user.rootlessstructRootless controls settings related to rootless container daemons.
system.user.uidint
system.user.gidint
system.user.mount_passwdbooltruePasswd controls weather a passwd file is mounted in the container at /etc/passwd to resolve missing user issues
system.user.passwd_filestring/etc/featherpanel/passwd
system.machine_idobjectMachineID controls the mounting of a generated `/etc/machine-id` file into containers started by Wings.
system.machine_id.enabledbooltrueEnable controls whether a generated machine-id file should be mounted into containers. By default this option is enabled and Wings will mount an additional machine-id file into containers.
system.machine_id.directorystring/run/wings/machine-idDirectory is the directory on disk where the generated machine-id files will be stored. This directory may be temporary as it will be re-created whenever Wings is started. This path **WILL** be both written to by Wings and mounted into containers created by Wings. If you are running Wings itself in a container, this path will need to be mounted into the Wings container as the exact path on the host, which should match the value specified here. If you are using SELinux, you will need to make sure this file has the correct SELinux context in order for containers to use it.
system.disk_check_intervalint64150The amount of time in seconds that can elapse before a server's disk space calculation is considered stale and a re-check should occur. DANGER: setting this value too low can seriously impact system performance and cause massive I/O bottlenecks and high CPU usage for the Wings process. Set to 0 to disable disk checking entirely. This will always return 0 for the disk space used by a server and should only be set in extreme scenarios where performance is critical and disk usage is not a concern.
system.quotasobjectQuotas define is quota management is enabled on the Data directory
system.quotas.enabledboolfalse
system.activity_send_intervalint60ActivitySendInterval is the amount of time that should ellapse between aggregated server activity being sent to the Panel. By default this will send activity collected over the last minute. Keep in mind that only a fixed number of activity log entries, defined by ActivitySendCount, will be sent in each run.
system.activity_send_countint100ActivitySendCount is the number of activity events to send per batch.
system.status_sync_intervalint300StatusSyncInterval is how often (in seconds) Wings re-reports each server's power state to the Panel. This keeps the Panel database accurate if a transition push was missed (daemon restart, temporary Panel outage, etc). Set to 0 to disable. Defaults to 300 (5 minutes).
system.check_permissions_on_bootbooltrueIf set to true, file ownership for a server will be synced to the Wings user when the process is booted (recursive chown). On large trees this can still take noticeable time; chown is skipped for files that already match the configured uid/gid. Set false if external tools do not modify ownership, or use a dedicated repair action when needed.
system.enable_log_rotatebooltrueIf set to false Wings will not attempt to write a log rotate configuration to the disk when it boots and one is not detected.
system.websocket_log_countint150The number of lines to send when a server connects to the websocket.
system.file_collaborationobjectFileCollaboration controls real-time collaborative file editing over the server websocket (Yjs CRDT), compatible with Calagopus-style clients.
system.file_collaboration.enabledbooltrueEnabled turns collaborative editing on or off for this node.
system.file_collaboration.file_size_capuint641048576FileSizeCap is the maximum file size in bytes that can be collaboratively edited.
system.file_collaboration.max_sessions_per_serveruint6416MaxSessionsPerServer limits concurrent collab sessions (files) per server.
system.file_collaboration.max_sessions_per_connectionuint648MaxSessionsPerConnection limits how many files one websocket may edit at once.
system.file_collaboration.max_editors_per_sessionuint6432MaxEditorsPerSession limits editor tabs for the same file on one connection.
system.file_collaboration.max_cursors_per_connectionuint6464MaxCursorsPerConnection limits awareness cursors tracked per connection.
system.file_collaboration.session_grace_perioduint6430SessionGracePeriod is how long (seconds) an empty session is kept before teardown.
system.file_historyobjectFileHistory controls Calagopus-compatible file revision snapshots.
system.file_history.enabledbooltrue
system.file_history.zstd_levelint3
system.file_history.anchor_intervaluint644
system.file_history.keep_chainsuint645
system.file_history.file_size_capuint641048576
system.file_history.per_file_disk_budgetuint645242880
system.file_history.per_server_disk_budgetuint64209715200
system.file_history.maintenance_intervaluint643600
system.sftpobjectSftpConfiguration defines the configuration of the internal SFTP server.
system.sftp.bind_addressstring0.0.0.0The bind address of the SFTP server.
system.sftp.bind_portint2022The bind port of the SFTP server.
system.sftp.read_onlyboolfalseIf set to true, no write actions will be allowed on the SFTP server.
system.sftp.max_connections_per_userintThe maximum number of connections a single user may have open at once, or zero to use the default of 32.
system.sftp.max_authenticating_connections_per_ipintThe maximum number of connections from a single IP address, or IPv6 /64 network, that may be authenticating at once, or zero to use the default of 16. Raise this if clients connect through a proxy, since they then all appear to come from the address of the proxy.
system.sftp.key_onlyboolfalseIf set to true users won't be able to login using their password.
system.sftp.allow_console_shellbooltrueAllowConsoleShell permits interactive SSH (shell/PTY) access to the game console for anyone who successfully authenticates on this listener. When false, the panel must include "control.console" in SFTP validation permissions (file-only subusers cannot open a shell).
system.fastdlobject
system.fastdl.enabledboolfalseEnabled controls whether FastDL is enabled. When enabled, nginx configuration will be generated for servers that have FastDL enabled. Requires nginx to be installed.
system.fastdl.bind_portint80The bind port for the nginx FastDL server.
system.fastdl.public_hostnamestringPublicHostname is the hostname clients use in sv_downloadurl (node FQDN). When empty, falls back to extracting a host from PanelLocation (legacy).
system.fastdl.nginx_config_pathstring/etc/nginx/sites-available/featherwings-fastdlNginxConfigPath is the path where nginx config files will be written. Defaults to /etc/nginx/sites-available/featherwings-fastdl
system.crash_detectionobject
system.crash_detection.enabledbooltrueCrashDetectionEnabled sets if crash detection is enabled globally for all servers on this node.
system.crash_detection.detect_clean_exit_as_crashbooltrueDetermines if Wings should detect a server that stops with a normal exit code of "0" as being crashed if the process stopped without any Wings interaction. E.g. the user did not press the stop button, but the process stopped cleanly.
system.crash_detection.timeoutint60Timeout specifies the timeout between crashes that will not cause the server to be automatically restarted, this value is used to prevent servers from becoming stuck in a boot-loop after multiple consecutive crashes.
system.crash_detection.max_restartsint0MaxRestarts specifies how many times a server may be automatically restarted after a crash before Wings stops attempting to recover it. The counter resets when the server is manually started. A value of 0 disables this limit.
system.crash_detection_activity_linesint2The ammount of lines the activity logs should log on server crash
system.host_terminalobjectHostTerminal controls interactive shell access to the host over websockets.
system.host_terminal.enabledbooltrueEnabled toggles whether the host terminal websocket is available.
system.host_terminal.shellstring/bin/bashShell specifies the shell executable to launch for terminal sessions.
system.host_terminal.disabled_commands[]stringDisabledCommands is a list of commands (full command or executable name) that cannot be executed.
system.backupsobject
system.backups.write_limitint0WriteLimit imposes a Disk I/O write limit on backups to the disk, this affects all backup drivers as the archiver must first write the file to the disk in order to upload it to any external storage provider. If the value is less than 1, the write speed is unlimited, if the value is greater than 0, the write speed is the value in MiB/s. Defaults to 0 (unlimited)
system.backups.compression_levelstringbest_speedCompressionLevel determines how much backups created by wings should be compressed. "none" -> no compression will be applied "best_speed" -> uses gzip level 1 for fast speed "best_compression" -> uses gzip level 9 for minimal disk space useage Defaults to "best_speed" (level 1)
system.backups.restore_host_allowlist[]stringRestoreHostAllowlist allows backup restore downloads to connect to otherwise blocked private/internal destinations. Entries may be hostnames, IP addresses, or CIDR ranges.
system.backups.remove_backups_on_server_deletebooltrueRemoveBackupsOnServerDelete deletes backups associated with a server when the server is deleted
system.backups.pbsobjectPBS configures the optional Proxmox Backup Server destination. When enabled, the panel may request adapter "pbs" so server files are streamed with proxmox-backup-client (pxar) instead of writing local tar.gz archives.
system.backups.pbs.enabledboolfalseEnabled marks this node as capable of using PBS as a backup destination. The panel reads this via Wings config to choose adapter "pbs" automatically.
system.backups.pbs.repositorystringRepository is the PBS repository string, e.g. "backup@[email protected]:datastore". Alternative component fields below may be used instead.
system.backups.pbs.serverstringServer, Port, Datastore, and AuthID are optional alternatives to Repository.
system.backups.pbs.portint
system.backups.pbs.datastorestring
system.backups.pbs.auth_idstring
system.backups.pbs.passwordstringPassword is the PBS user password or API token secret (PBS_PASSWORD).
system.backups.pbs.fingerprintstringFingerprint is an optional TLS certificate pin (PBS_FINGERPRINT). Leave empty when the PBS cert is issued by a trusted CA (e.g. Let's Encrypt / ACME); proxmox-backup-client does not require it then, and pinning breaks on renewal. Set only for self-signed or otherwise untrusted certificates.
system.backups.pbs.namespacestringfeatherpanelNamespace is the PBS namespace for FeatherPanel backups (default "featherpanel").
system.backups.pbs.binarystringproxmox-backup-clientBinary is the proxmox-backup-client executable path/name.
system.backups.pbs.archive_namestringroot.pxarArchiveName is the pxar archive name inside each snapshot (without path). Defaults to root.pxar so PBS file browser matches PVE CT backups (root.pxar.didx).
system.backups.pbs.change_detection_modestringmetadataChangeDetectionMode is passed to proxmox-backup-client (--change-detection-mode). "metadata" is recommended so unchanged files are not re-read when possible.
system.backups.pbs.keyfilestringKeyFile is an optional client-side encryption key file path.
system.backups.pbs.encryption_passwordstringEncryptionPassword unlocks KeyFile when set (PBS_ENCRYPTION_PASSWORD).
system.transfersobject
system.transfers.download_limitint0DownloadLimit imposes a Network I/O read limit when downloading a transfer archive. If the value is less than 1, the write speed is unlimited, if the value is greater than 0, the write speed is the value in MiB/s. Defaults to 0 (unlimited)
system.transfers.perform_checksum_checksboolfalsePerformChecksumChecks controls whether incoming transfer archives are validated against the provided SHA-256 checksum. If set to false, the destination node will not enforce checksum verification; the archive will be extracted as received and the checksum part (if present) is ignored. This can be useful for trusted networks or debugging, but reduces protection against corrupted or tampered archives. Defaults to false; set to true to enforce checksum validation.
system.transfers.storage_poolobjectStoragePool configures whether this node participates in a shared storage pool.
system.transfers.storage_pool.enabledboolfalseEnabled signals that this node shares a common data volume with other nodes.
system.transfers.storage_pool.pool_namestringPoolName is a per-node identifier used to compare shared storage pool membership across nodes.
system.openat_modestringauto
system.updatesobjectUpdates controls runtime update capabilities.
system.updates.enable_urlbooltrueEnableURL controls whether URL driven self-updates are permitted.
system.updates.allow_apibooltrueAllowAPI controls whether the HTTP API may invoke self-updates.
system.updates.disable_checksumbooltrueDisableChecksum skips checksum verification for all self-updates.
system.updates.restart_commandstringsystemctl restart featherwingsRestartCommand, when set, is executed after a successful self-update.
system.updates.repo_ownerstringmythicalltdRepoOwner defines the default GitHub repository owner used for self-updates.
system.updates.repo_namestringfeatherwingsRepoName defines the default GitHub repository name used for self-updates.
system.updates.github_binary_templatestringwings_linux_{arch}GitHubBinaryTemplate defines the asset name template (supports {arch} placeholder).
system.updates.default_urlstringDefaultURL, when set, is used as the fallback direct download source for URL based updates.
system.updates.default_sha256stringDefaultSHA256 optionally provides a checksum for DefaultURL.

docker

KeyTypeDefaultDescription
dockerobjectDockerConfiguration defines the docker configuration used by the daemon when interacting with containers and networks on the system.
docker.networkobjectNetwork configuration that should be used when creating a new network for containers run through the daemon.
docker.network.interfacestring172.19.0.1The interface that should be used to create the network. Must not conflict with any other interfaces in use by Docker or on the system.
docker.network.dns[]string["1.1.1.1", "1.0.0.1"]Dns is the list of DNS servers for containers. When empty or omitted, Docker uses its embedded resolver (127.0.0.11), which forwards to the host's resolvers and avoids resolution failures when custom DNS IPs are unreachable from the bridge (e.g. firewall, or api.minecraftservices.com / Yggdrasil auth failing). Set explicitly if you need containers to use specific resolvers (e.g. 8.8.8.8).
docker.network.namestringfeatherpanel_nwThe name of the network to use. If this network already exists it will not be created. If it is not found, a new network will be created using the interface defined.
docker.network.ispnboolfalse
docker.network.IPv6booltrue
docker.network.driverstringbridge
docker.network.network_modestringfeatherpanel_nw
docker.network.is_internalboolfalseIsInternal, when true, creates an internal-only network: containers cannot reach the internet (e.g. Minecraft auth to api.minecraftservices.com will fail). Leave false for game servers that need outbound access.
docker.network.enable_iccbooltrue
docker.network.network_mtuint641500
docker.network.interfacesdockerNetworkInterfaces
docker.domainnamestringDomainname is the Docker domainname for all containers.
docker.registriesmap[string]RegistryConfigurationRegistries .
docker.tmpfs_sizeuint100TmpfsSize specifies the size for the /tmp directory mounted into containers. Please be aware that Docker utilizes the host's system memory for this value, and that we do not keep track of the space used there, so avoid allocating too much to a server.
docker.container_pid_limitint64512ContainerPidLimit sets the total number of processes that can be active in a container at any given moment. This is a security concern in shared-hosting environments where a malicious process could create enough processes to cause the host node to run out of available pids and crash.
docker.installer_limitsobjectInstallerLimits defines the limits on the installer containers that prevents a server's installation process from unintentionally consuming more resources than expected. This is used in conjunction with the server's defined limits. Whichever value is higher will take precedence in the installer containers.
docker.installer_limits.memoryint641024
docker.installer_limits.cpuint64100
docker.cpu_sharesint641024CpuShares is the relative CFS weight given to server containers that have a CPU limit, used when the host is fully saturated; it limits nothing on an idle host. It defaults to 1024, which is what Wings has always set. Set it to 0 to leave containers at the engine default: cgroup v2 turns 1024 shares into less than half of its default weight, so 0 gives servers more weight than host system services.
docker.overheadobjectOverhead controls the memory overhead given to all containers to circumvent certain software such as the JVM not staying below the maximum memory limit.
docker.overhead.overrideboolfalseOverride controls if the overhead limits should be overridden by the values in the config file.
docker.overhead.default_multiplierfloat641.05DefaultMultiplier sets the default multiplier for if no Multipliers are able to be applied.
docker.overhead.multipliersmap[int]float64Multipliers allows overriding DefaultMultiplier depending on the amount of memory configured for a server. Default values (used if Override is `false`) - Less than 2048 MB of memory, multiplier of 1.15 (15%) - Less than 4096 MB of memory, multiplier of 1.10 (10%) - Otherwise, multiplier of 1.05 (5%) - specified in DefaultMultiplier If the defaults were specified in the config they would look like: ```yaml multipliers: 2048: 1.15 4096: 1.10 ```
docker.use_performant_inspectbooltrue
docker.runtime_reconciliationobjectRuntimeReconciliation periodically verifies Docker runtime state against the process state Wings tracks, recovering servers stuck in starting/stopping when Docker and containerd become desynchronized or Docker API calls hang.
docker.runtime_reconciliation.enabledbooltrueEnabled turns on the periodic runtime reconciliation cron. Defaults to true.
docker.runtime_reconciliation.interval_secondsint30IntervalSeconds is how often each server is checked. Defaults to 30s.
docker.runtime_reconciliation.inspect_timeout_secondsint5InspectTimeoutSeconds bounds ContainerInspect / IsRunning probes used by reconciliation. If Docker hangs past this, the runtime is treated as unresponsive.
docker.runtime_reconciliation.stuck_stopping_secondsint720StuckStoppingSeconds is how long a server may remain in "stopping" before Wings forces recovery. Should exceed the normal power stop wait (10m).
docker.runtime_reconciliation.stuck_starting_secondsint300StuckStartingSeconds is how long a server may remain in "starting" while Docker is unresponsive before Wings marks it as a runtime error. Responsive Docker with a long boot is ignored; slow games are normal.
docker.runtime_reconciliation.unresponsive_thresholdint2UnresponsiveThreshold is consecutive inspect failures required before a server is marked as a runtime error and recovered.
docker.runtime_reconciliation.recovery_cooldown_secondsint300RecoveryCooldownSeconds is the minimum time between automatic recoverRuntime attempts for a server. Prevents terminate/destroy storms when Docker stays hung. Force-reconcile ignores this. Defaults to 300s (5 minutes).
docker.userns_modestringSets the user namespace mode for the container when user namespace remapping option is enabled. If the value is blank, the daemon's user namespace remapping configuration is used, if the value is "host", then the featherpanel containers are started with user namespace remapping disabled
docker.system_ips[]string[]Sets the IPS that the user is able to bind to
docker.enable_native_kvmboolEnableNativeKVM enables native KVM support for containers. This allows containers to access /dev/kvm for hardware-accelerated virtualization. The default value is automatically set to true if KVM is available on the host system, otherwise false.
docker.log_configobject
docker.log_config.typestringlocal
docker.log_config.configmap[string]string{"max-size":"5m","max-file":"1","compress":"false","mode":"non-blocking"}

sentry

KeyTypeDefaultDescription
sentryobjectSentry configures GlitchTip / Sentry-compatible error reporting.
sentry.enabledbooltrueEnabled controls whether the SDK is initialized. When false, no events are sent.
sentry.dsnstringhttps://[email protected]/4Dsn is the Sentry/GlitchTip project DSN. An empty value disables reporting even when Enabled is true.
sentry.environmentstringproductionEnvironment is attached to every event (for example production or staging).
sentry.traces_sample_ratefloat640.01TracesSampleRate is the fraction of transactions sent (0.0 to 1.0). Keep this low in production to limit storage on self-hosted GlitchTip.

throttles

KeyTypeDefaultDescription
throttlesobjectDefines internal throttling configurations for server processes to prevent someone from running an endless loop that spams data to logs.
throttles.enabledbooltrueWhether or not the throttler is enabled for this instance.
throttles.linesuint642000The total number of lines that can be output in a given Period period before a warning is triggered and counted against the server.
throttles.line_reset_intervaluint64100The amount of time after which the number of lines processed is reset to 0. This runs in a constant loop and is not affected by the current console output volumes. By default, this will reset the processed line count back to 0 every 100ms.

remote_query

KeyTypeDefaultDescription
remote_queryobjectRemoteQueryConfiguration defines the configuration settings for remote requests from Wings to the Panel.
remote_query.timeoutint30The amount of time in seconds that Wings should allow for a request to the Panel API to complete. If this time passes the request will be marked as failed. If your requests are taking longer than 30 seconds to complete it is likely a performance issue that should be resolved on the Panel, and not something that should be resolved by upping this number.
remote_query.boot_servers_per_pageint50The number of servers to load in a single request to the Panel API when booting the Wings instance. A single request is initially made to the Panel to get this number of servers, and then the pagination status is checked and additional requests are fired off in parallel to request the remaining pages. It is not recommended to change this from the default as you will likely encounter memory limits on your Panel instance. In the grand scheme of things 4 requests for 50 servers is likely just as quick as two for 100 or one for 400, and will certainly be less likely to cause performance issues on the Panel.
remote_query.custom_headersmap[string]stringCustomHeaders is a map of custom headers that will be included in all requests made to the Panel API. This is useful for authentication with services like Cloudflare Access using service tokens (e.g., CF-Access-Client-Id and CF-Access-Client-Secret).
KeyTypeDefaultDescription
SearchobjectSearchRecursion holds the configuration for directory search recursion settings.
Search.blacklisted_dirs[]string["node_modules", ".git", ".wine", "appcache", "depotcache", "vendor"]BlacklistedDirs is a list of directory names that should be excluded from the recursion.
Search.max_recursion_depthint8MaxRecursionDepth specifies the maximum depth for directory recursion.