Skip to main content

Initialization

Before starting the mount client, it is necessary to tell it where to find the administrative service and to initialize the token it will use to authenticate with it and identify the associated volume. This can be done easily using the init command.

sudo mount.flexfs init \
--adminAddr <admin-addr> --token <volume-token>

Creds file

The init command is simply a convenience that creates a TOML-formatted credentials file in the right location and with the correct permissions. By default, this file is created at /root/.flexfs/mount/creds/<name> where <name> is the name of the volume corresponding to the provided volume token (this path can be changed with the --credsFile flag). When not run using sudo, this structure is created in the home directory of the user that ran the init command. The intermediate folders .flexfs, mount, and creds are created with 700 permissions and the <name> file is created with 600 permissions.

info

This file can be created manually to avoid the need to run the init command. That approach is sometimes useful in various dev ops scenarios.

This file will look something like this:

adminAddr = "example.flexfs.io"
token = "20ae2ac2-1d39-4ff0-9000-66ca5d8b8478"