Skip to main content

Filesystem

Server Source code Package

Local filesystem store for walkerOS server flows. Reads and writes files relative to a base directory with path traversal protection.

Installation​

Loading...
Loading...

Configuration​

This store uses the standard store config wrapper (consent, data, env, id, ...). For the shared fields see store configuration. Package-specific fields live under config.settings and are listed below.

Settings​

PropertyTypeDescriptionMore
basePath*stringRoot directory for file operations. All keys are resolved relative to this path.
* Required fields

Mapping​

This package does not define custom rule-level settings. For the standard rule fields (consent, condition, data, batch, name, policy) see mapping.

Examples

path traversal rejection

Event
Out

read existing file

Event
Out

write new file

Event
Out

API​

Loading...

get() returns Buffer for compatibility with the file transformer, which uses content instanceof Buffer for Content-Length calculation.

File serving pattern​

Use with the file transformer to serve static assets from the local filesystem:

Loading...

A request to /static/walker.js reads ./public/walker.js from disk.

Security​

  • Path traversal protection: Requests with .., absolute paths, or backslash traversal are rejected and logged as warnings
  • Base path scoping: All operations are restricted to the configured basePath directory
  • Intermediate directories: set() creates parent directories automatically via mkdir -p

When to use​

ScenarioRecommended store
Local developmentFilesystem: files on disk, no credentials needed
Docker with baked-in assetsFilesystem: mount or copy files into the image
Cloud / managed deploymentsS3: files in a bucket, hot-swappable
Caching / ephemeral dataMemory: fastest, no I/O
💡 Need implementation support?
elbwalker offers hands-on support: setup review, measurement planning, destination mapping, and live troubleshooting. Book a 2-hour session (€399)