// getting-started

Configuration

PrismaFS resolves its layer configuration in this order:

  1. -c <config-file> command-line flag if provided.
  2. SESSION_LAYER_DIR and BASE_LAYER_DIRS environment variables, if -c is not provided.
  3. config file by auto-detection at ~/.config/prismafs/default.conf, when above two points dont apply or environment vars are not provided.
  4. If above dont resolve, PrismaFS prints usage guide and exits without mounting.

Guided setup

prismafs init

Prompts for SESSION directory and BASE directory, then writes ~/.config/prismafs/default.conf. After this, running prismafs <mountpoint> with no other arguments uses this file automatically.

Release check is Guided setup (init).

Config file format

Plain text, one directive per line. Lines starting with # are comments, empty lines ignored.

# my analysis environment
session /tmp/session
base /opt/project-base
base /usr/local/share/common
  • session <path>: required, exactly once. Directory used for all writes.
  • base <path>: required, at least once. Can be repeated. Order determines reading priority, first listed is top priority if conflicting at BASE layers.

Environment variable format

export SESSION_LAYER_DIR=/tmp/session
export BASE_LAYER_DIRS=/tmp/base1,/tmp/base2

BASE_LAYER_DIRS is comma separated list. Order determines reading priority, same as in case of config file.