Skip to content

free.flexfs

free.flexfs is the server for flexFS Community edition. It manages a single volume and provides the same deploy endpoint as the Enterprise admin server for mount client installation and auto-updates. All flags are public.

SubcommandDescription
deinit credsRemove the credentials file
deinit systemdRemove the systemd service unit
init credsInitialize the credentials file
init systemdCreate and enable a systemd service unit
licensePrint license information
startStart the server
versionPrint the build version
Terminal window
free.flexfs start [flags]
FlagTypeDefaultDescription
--credsFilestring~/.flexfs/free/credsCredentials file path
FlagTypeDefaultDescription
--bindAddrstring0.0.0.0:443Address and port to bind
--noInstallerboolfalseDisable the /deploy/install-mount.sh installer endpoint
--noSSLboolfalseDisable SSL for the REST API
--sslCertstring~/.flexfs/ssl/certSSL certificate file path
--sslKeystring~/.flexfs/ssl/keySSL private key file path
Terminal window
free.flexfs init creds [flags]

Initializes a credentials file for the server with block storage and metadata configuration.

FlagTypeDefaultDescription
--apistring""Block storage API (e.g., s3, gcs, azure, oci)
--blockAddrstring""Custom block storage endpoint (optional)
--blockPassstring""Block storage password (optional)
--blockUserstring""Block storage username (optional)
--bucketstring""Block storage bucket
--forceboolfalseOverwrite existing creds file
--metaAddrstring""Metadata server address (host:port)
--prefixstringflexfsBlock storage key prefix
--providerstring""Cloud provider (e.g., aws, gcp, azure, oci)
--regionstring""Cloud region (e.g., us-east-1)
--retentionint64604800Block retention period in seconds
Terminal window
sudo free.flexfs init systemd [flags]

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

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

Removes the credentials file for the 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 free.flexfs deinit systemd

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

The Community server differs from the Enterprise admin server in the following ways:

  • Manages a single volume (no multi-volume support)
  • No configure.flexfs support
  • No proxy group management
  • No end-to-end encryption
  • No dynamic CSI provisioning
  • No volume quotas or volume tokens with mount-path scoping

All CLI utilities (analyze.flexfs, dedup.flexfs, find.flexfs, manage.flexfs, update.flexfs) work with the Community edition. Local on-disk writeback caching (--diskWriteback) is available on the mount client to help mitigate object storage latency.