Files Hierarchy
A Staxis project keeps the Core, application packs, configuration, and runtime files in separate locations. The following tree shows the default layout. The paths for packs, logs, temporary files, and execution helpers are configurable in config.js.
project-root/ ├── system-core/ │ ├── methods/ │ ├── engine.js │ ├── hmac.js │ ├── manager.js │ ├── vault.js │ └── .security.example ├── system-lrpcks/ │ └── helloworld/ │ ├── config.js │ ├── main.js │ └── manifest.json ├── system-logs/ ├── system-temp/ ├── .gitignore ├── .hmac.example ├── .keys.example ├── config.js ├── package.json ├── project ├── LICENSE └── README.md
This is an overview of the main files. Installing packs and running the project can add dependencies, output files, and pack-specific directories.
-
system-core/
Contains the Core Orchestrator, Manager, Vault, integrity utilities, and their supporting methods. Application functionality belongs in packs. The optional system-core/.security file selects the runtime security profile. The Core uses max-security when that file is absent.
-
system-lrpcks/
Contains the layer packs available to the project. Each pack has its own directory and a manifest.json that describes its entry point, requirements, and permissions. The stack in the project configuration selects the packs to load and their order. The included helloworld pack provides a small working example.
-
system-logs/
The default location for log and crash output from components configured to write there. Which files appear depends on the installed packs and logging settings.
-
system-temp/
The default location for temporary working files. Packs can use it for downloads, generated files, or other transient data according to their configuration.
-
node_modules/
npm creates this directory when dependencies are installed. Node.js resolves packages from it when the code imports them. The Core has no third-party runtime dependencies, while packs can use npm packages for the functionality they provide.
-
config.js
Defines the stack, folder paths, and options for orchestration, logging, and Guardian. Packs can also have their own configuration files for their specific settings.
-
.keys
Stores the local key material used by the Vault and managed layers. Use .keys.example as the starting point and set your own values. Access to managed keys is governed by Vault permissions. The file itself requires appropriate filesystem protection and exclusion from version control. Environment variables are also supported where the application or a pack uses them.
-
.hmac
The local registry used for pack integrity verification. Start from .hmac.example during setup. It records integrity information for covered pack files and is checked according to the selected security profile.
-
.roll Profiles
Optional installation profiles list packs to provision together. The Manager's unroll command reads these profiles to install a stack in one operation. Available profiles depend on the project or installer you choose.
-
package.json
Declares the Node.js package settings, supported runtime, scripts, and npm dependencies for the project. npm can also create a lockfile when resolving dependencies.
-
project
The command-line launcher. Use node project start to run the application and node project manager to open the Manager.
-
system-exec/
An optional directory for launch scripts and process-management helpers. Its path is configured in config.js and it appears when the project uses those tools.
-
.gitignore
Defines which untracked files Git should ignore, including local keys, integrity records, logs, and temporary files in the default project. Files already tracked by Git remain tracked when an ignore rule is added.