Filesystem

Filesystem

Directory and embedded filesystem access.

Entry Kinds

Kind	Description
fs.directory	Directory-based filesystem
fs.embed	Read-only embedded filesystem

Directory Filesystem

- name: uploads
  kind: fs.directory
  directory: "/var/data/uploads"
  auto_init: true
  mode: "0755"

Field	Type	Default	Description
directory	string	required	Root path
auto_init	bool	false	Create directory if missing
mode	string	0755	Unix permission mode (octal)

The mode restricts all file operations. Execute bits are added automatically when read bits are present.

Paths are normalized and validated. It is not possible to access files outside the configured root directory.

Embedded Filesystem

- name: static
  kind: fs.embed

Embedded filesystems load from pack resources using the entry ID. They are read-only.

Embedded filesystems are an internal mechanism. Manual configuration is typically not required.

Operations

Both filesystem types implement:

Operation	Directory	Embed
Open/Read	Yes	Yes
Stat	Yes	Yes
ReadDir	Yes	Yes
OpenFile (write)	Yes	No
Remove	Yes	No
Mkdir	Yes	No

Write operations on embedded filesystems return an error.

Lua API

See Filesystem Module for file operations.

See Also

• Filesystem Module - Lua API reference
• Cloud Storage - S3-compatible object storage
• Template - Templates loaded from filesystems