Metadata

Files and folders can be annotated with metadata. Metadata is stored in a file called <name>.dbmeta.json, where <name> is the exact file (including extension) or folder name. Put it in the same folder as the target file or folder. Metadata is stored in a JSON format specified below.

The *.dbmeta.json files are hidden from the user and cannot be viewed.

/foo bar/cool project.dbmeta.json

{
  "description": "A short project description ⭐",
  "labels": ["danger:Laravel", "primary:PHP 8", "dark:Hot 🔥"],
  "hidden": false,
  "password": "mysecurepassword",
  "hash_required": false
}

info

If you are looking for the ".dbmeta.md" files, see Readme Rendering.

Properties

Description

A short description of the file or folder. This is displayed in the file tree.

Default is empty.

Labels

Labels always start with a style and a colon :, followed by the label text. The following styles are available:

• primary
• secondary
• success
• danger
• warning
• info
• light
• dark

warning

Labels must not contain a semicolon ;.

Default is empty.

Hidden

warning

The file can still be accessed via URL directly. If you want to ignore it completely, consider using an IGNORE pattern.

If set to true, the file or folder is hidden from the file tree. Can be combined with password protection.

Default is false.

Password

See Password Protection.

Default is empty.

Hash Required

See Integrity & Hashes.

Default is false.

⚙️ Configuration

Variable	Default	Values	Details
METADATA	true	true false	Enables support for metadata parsing. Disabling this feature will therefore disable all metadata related features like file passwords.added in v3.3

How to set configuration options

Set the environment variables when starting the container.
Use docker run...

• ...with -e METADATA=true
• ...with --env-file .env and place METADATA=true in the file

See installation page for more details.