Edit on GitHub

Workspace

The Workspace directory stores project-specific files like data sources, pages, utilities, and uploads.

Overview

A Symphony project’s Workspace is a directory that contains all project-specific files. By default, the workspace will store data sources, events, pages, utilities, and any files that are uploaded via fields in an entry. Often, developers will use the workspace directory to store other assets as well, such as CSS and JavaScript files or template images.

Usage

As long as the default subdirectories are left intact, users are free to create any desired directory structure within the workspace folder.

A workspace's URL is included as a system parameter by Symphony.

Details

By default, the system will create and use four subdirectories within the workspace:


/data-sources
/events
/pages
/utilities

Physical files representing each of the above elements are stored here and can be edited directly in lieu of using the admin interface's editors.

Additional subdirectories can be created as needed. Common practices include creating directories for assets (like /styles, /images, and /scripts) and an /uploads folder to serve as a target for file upload fields.

The Big Picture

A Symphony project's workspace contains all of the files that make it unique from other Symphony builds. A "clean" Symphony install contains no workspace—an empty one is generated during installation. The workspace folder is included when creating ensembles.

File upload fields must choose folders in workspace/ as their target.