Skip to content

Configuration

You'll need to configure spaces and users:

  • Spaces represent compartments of files to help you organize by purpose or access.
  • Users, of course, help us give people access to those spaces.

WARNING

The main config file is in active development and unstable at the moment. Some of these fields don't do anything and others will likely move or be renamed. Keep an eye on this page between updates to stay on top of those changes.

config.yaml
yaml
spaces:
    # a unique name for the space that determines the path on the filesystem
    # (e.g. 'home' -> 'cabynet/spaces/home')
  - name: home
    # overrides how the space is displayed in the UI; can include emojis
    display: 🏠 Home
    # note how only the name is required for a space
  - name: media
users:
    # the username of the user; functions like an ID so it needs to be unique
    # for each user
  - name: caby_guy
    # an optional email for the user
    email: caby_guy@caby.io
    # 64-character string used to activate the user's account on first login
    activation_token: loading...
    # the spaces this user should have access to
    spaces:
      - name: home
        permissions: "*"