Documentation

Everything you need to deploy and serve static assets with Volstat.

Quick start

Install the CLI, sign in and deploy a build directory:

$ npm i -g volstat
$ volstat login
$ volstat deploy ./dist

Every deploy gets its own immutable URL. Promote it to production when you are ready.

Deployments

Files are content-addressed, so unchanged assets are never uploaded twice. Rolling back is instant because previous deployments stay available:

$ volstat deploys list
$ volstat promote a1b2c3
$ volstat rollback

Caching rules

Define rules per path in volstat.json:

{
  "rules": [
    { "path": "/assets/*", "ttl": 31536000, "immutable": true },
    { "path": "/*.html",  "ttl": 60, "swr": 600 }
  ]
}

Purge API

Purge by URL or tag. Changes propagate to all regions within a few seconds.

MethodPathDescription
POST/v1/purgePurge URLs or tags
GET/v1/deploysList deployments
POST/v1/promotePromote a deployment

Custom domains

Add a CNAME record pointing to your project hostname. Certificates are issued and renewed automatically; most domains are active within a few minutes.

Limits

PlanBandwidthProjectsMax file size
Hobby10 GB125 MB
Pro1 TBUnlimited100 MB
Business5 TBUnlimited500 MB

Need something else? Contact us.