@static

Configure the static asset S3 bucket deployed by Architect.

Note: @static is implied if @http is defined.

Syntax

All parameters are optional.

  • fingerprint - boolean (defaults to false)
    • Enable static asset file fingerprinting (and long-lived caching headers)
  • folder - string (defaults to ./public)
    • Designate the local folder to upload static assets from.
  • ignore - list
    • Define which assets in the static folder should be ignored during upload
  • prefix - string
    • Set a top-level directory in the S3 bucket where files will be deployed
  • prune - boolean (defaults to false)
    • Automatically remove assets from S3 bucket not found in the static folder
  • spa - boolean (defaults to false)
    • Enable “Single Page App” delivery: all page requests route to the root.

📜 The Frontend Static assets guide has more information on how to use static assets in your Architect project.

Example

This app.arc file uses all @static options:

arc
@app
test-app

@static
fingerprint true
folder ./dist
ignore
  .tar.gz
  tmp
  user
prune true
prefix assets
spa true
json
{
  "app": "test-app",
  "static": {
    "fingerprint": true,
    "folder": "./dist",
    "ignore": [
      ".tar.gz",
      "tmp",
      "user"
    ],
    "prune": true,
    "prefix": "assets",
    "spa": true,
  }
}
yaml
---
app: testapp

static:
  fingerprint: true
  folder: ./dist
  ignore:
    - ".tar.gz"
    - "tmp"
    - "user"
  prune: true
  prefix: assets
  spa: true