Skip to content
flexFS

Proxy Server Setup

Installation

Section titled “Installation”

The proxy server binary (proxy.flexfs) is included in the flexFS Enterprise installation. It is typically deployed via the admin server’s deploy endpoint or the manage.flexfs tool.

Initialize credentials

Section titled “Initialize credentials”

If the proxy server needs static block storage credentials (access key and secret), initialize them before starting:

Terminal window
proxy.flexfs init creds \
  --blockUser <username> \
  --blockPass <password>

This writes a TOML credentials file to the default location (~/.flexfs/proxy/creds):

blockPass = "<password>"
blockUser = "<username>"

See proxy.flexfs init creds for the full list of flags and their defaults.

Create systemd service

Section titled “Create systemd service”
Terminal window
sudo proxy.flexfs init systemd --now

This creates and enables a systemd unit at /etc/systemd/system/flexfs-proxy.service and optionally starts it immediately.

To pass additional flags to the proxy server at startup:

Terminal window
sudo proxy.flexfs init systemd --now \
  --startFlags "--diskFolder /data/proxy-cache --diskQuota 500G"

See proxy.flexfs init systemd for the full list of flags and their defaults.

Start flags

Section titled “Start flags”

See proxy.flexfs start for the full list of flags and their defaults.

TLS certificates

Section titled “TLS certificates”

By default, the proxy server auto-generates a self-signed TLS certificate if none exists at the configured paths. To use custom certificates:

Terminal window
proxy.flexfs start \
  --sslCert /etc/ssl/proxy.crt \
  --sslKey /etc/ssl/proxy.key

For testing or internal networks, --noSSL disables TLS entirely.

Verifying the server

Section titled “Verifying the server”

After starting, the proxy server logs its configuration:

proxy.flexfs | v1.9.0
--------------------------------------------------------------------------------
      bindAddr | 0.0.0.0:443
    diskFolder | /cache
     diskQuota | 90% (450.00 GiB)
       sslCert | ~/.flexfs/ssl/cert
        sslKey | ~/.flexfs/ssl/key
--------------------------------------------------------------------------------
Binding to 0.0.0.0:443 (encrypted)

The server is ready to accept block requests from mount clients once the bind message appears.