Skip to content

admin.flexfs

admin.flexfs is the central management server for flexFS Enterprise. It stores accounts, volumes, block stores, metadata stores, proxy groups, and volume tokens. Mount clients connect to it for volume settings and binary updates, and configure.flexfs uses its REST API to manage resources.

SubcommandDescription
startStart the admin server
init credsInitialize the credentials file
init systemdCreate and enable a systemd service unit
deinit credsRemove the credentials file
deinit systemdRemove the systemd service unit
versionPrint the build version
licensePrint license information
Terminal window
admin.flexfs start [flags]
FlagTypeDefaultDescription
--credsFilestring~/.flexfs/admin/credsCredentials file path
FlagTypeDefaultDescriptionVisibility
--bindAddrstring0.0.0.0:443Address and port to bindPublic
--dbFolderstring~/.flexfs/adminDatabase folder pathPublic
--deployFolderstring~/.flexfs/admin/deployFolder for mount client deploy binariesPublic
--noSSLboolfalseDisable SSL for the REST APIPublic
--sslCertstring~/.flexfs/ssl/certSSL certificate file pathPublic
--sslKeystring~/.flexfs/ssl/keySSL private key file pathPublic
--verbose, -vboolfalseEnable verbose loggingPublic
--noStatSSLboolfalseDisable SSL for stat server connectionsInternal
--pprofboolfalseEnable pprof profilerInternal
--sqliteOptsstring(default tuning)Database connection tuning optionsInternal
--statAddrstringStat server address (overrides creds file)Internal
--tokenstringAdmin server auth token (overrides creds file)Internal
Terminal window
admin.flexfs init creds [flags]

Initializes a credentials file for the admin server. If --token is omitted, the command prompts for an admin server token interactively.

FlagTypeDefaultDescription
--statAddrstringstat.flexfs.ioStat server address
--tokenstring""Admin server auth token (will prompt if omitted)
--forceboolfalseOverwrite existing creds file
Terminal window
sudo admin.flexfs init systemd [flags]

Creates and enables a systemd service unit (flexfs-admin.service) for the admin server. Requires root.

FlagTypeDefaultDescription
--nowboolfalseStart the service immediately after enabling
--startFlagsstring""Additional flags to pass to the start command
--forceboolfalseOverwrite existing systemd unit file
Terminal window
admin.flexfs deinit creds [flags]

Removes the credentials file for the admin server. If the credentials file is referenced by a systemd unit, the command refuses unless --force is passed, in which case it removes the references too.

FlagTypeDefaultDescription
--forceboolfalseRemove creds even if referenced by systemd (removes references too)
Terminal window
sudo admin.flexfs deinit systemd

Removes the systemd service unit (flexfs-admin.service) for the admin server. Requires root.

The admin server serves mount client binaries and an installer script for auto-update and client deployment:

EndpointDescription
/deploy/install-mount.shShell script that downloads and configures the mount client
/deploy/production/Production channel mount client binaries
/deploy/staging/Staging channel mount client binaries