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.

Subcommands

| Subcommand | Description | |---|---| | deinit creds | Remove the credentials file | | deinit systemd | Remove the systemd service unit | | init creds | Initialize the credentials file | | init systemd | Create and enable a systemd service unit | | license | Print license information | | start | Start the admin server | | version | Print the build version |

Usage

admin.flexfs start [flags]

Persistent Flags

| Flag | Type | Default | Description | |---|---|---|---| | --credsFile | string | ~/.flexfs/admin/creds | Credentials file path |

Start Flags

| Flag | Type | Default | Description | Visibility | |---|---|---|---|---| | --bindAddr | string | 0.0.0.0:443 | Address and port to bind | Public | | --dbFolder | string | ~/.flexfs/admin | Database folder path | Public | | --deployFolder | string | ~/.flexfs/admin/deploy | Folder for mount client deploy binaries | Public | | --noSSL | bool | false | Disable SSL for the REST API | Public | | --noStatSSL | bool | false | Disable SSL for stat server connections | Internal | | --pprof | bool | false | Enable pprof profiler | Internal | | --pprofPort | int | 6060 | Pprof server port | Internal | | --sqliteOpts | string | _journal=WAL&_cache_size=10240&_fk=true&_timeout=5000 | SQLite database connection options | Internal | | --sslCert | string | ~/.flexfs/ssl/cert | SSL certificate file path | Public | | --sslKey | string | ~/.flexfs/ssl/key | SSL private key file path | Public | | --statAddr | string | | Stat server address (overrides creds file) | Internal | | --token | string | | Admin server auth token (overrides creds file) | Internal | | --verbose, -v | bool | false | Enable verbose logging | Public |

Init Creds

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.

| Flag | Type | Default | Description | |---|---|---|---| | --force | bool | false | Overwrite existing creds file | | --statAddr | string | stat.flexfs.io | Stat server address | | --token | string | "" | Admin server auth token (will prompt if omitted) |

Init Systemd

sudo admin.flexfs init systemd [flags]

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

| Flag | Type | Default | Description | |---|---|---|---| | --force | bool | false | Overwrite existing systemd unit file | | --now | bool | false | Start the service immediately after enabling | | --startFlags | string | "" | Additional flags to pass to the start command |

Deinit Creds

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.

| Flag | Type | Default | Description | |---|---|---|---| | --force | bool | false | Remove creds even if referenced by systemd (removes references too) |

Deinit Systemd

sudo admin.flexfs deinit systemd

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

Deploy Endpoints

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

| Endpoint | Description | |---|---| | /deploy/install-mount.sh | Shell script that downloads and configures the mount client | | /deploy/production/ | Production channel mount client binaries | | /deploy/staging/ | Staging channel mount client binaries |