Deplay / docs

Documentation

How Deplay builds, publishes and monitors your sites and APIs.

Deployment

A deployment always goes through the same three steps, whether it is a static site or a web service.

01
Connect
Import a GitHub repository, or upload your files directly. Deplay detects the framework and pre-fills the commands.
02
Deploy
The build runs in an isolated container, separate from your account and other projects, with 2 GB of memory and 2 CPUs.
03
Monitor
Build logs, runtime logs and storage usage are visible live from the dashboard.

Command line (CLI)

Deploy a local folder without opening the dashboard. Requires Node.js 18.17 or later. Only websites are supported for now.

01
Create a token
In Settings → CLI tokens, name the token and create it. Copy it right away: it is shown only once.
02
Log in
npx deplay-cli login --token dpl_xxxxxxxx
03
Deploy a folder
cd my-site && npx deplay-cli deploy

On the first deploy the CLI detects the framework, asks for a project name and links the folder through .deplay/project.json. Next runs re-upload the files and rebuild the same project.

Useful commands: deplay whoami, deplay logout, deplay deploy ./dist --preset static (already-built site), --name, --yes, --no-wait, --new. Install once with npm install -g deplay-cli to use the short deplay command.

Never sent: node_modules, .git, .env files and build folders. Add more exclusions in a .deplayignore file (same syntax as .gitignore). Environment variables are set in the project page, not read from your .env. Limits: 200 MB and 5,000 files per upload.

In CI, set DEPLAY_TOKEN and run npx deplay-cli deploy --yes; commit .deplay/project.json so that CI updates the same project.

Web services

A web service is a long-running process listening on a port, with its own public address (<name>.fabrich.site). Two runtimes are available: see Runtimes. A stopped service restarts on its own; limit of 2 services per account, 1 GB of memory each.

Environment variables

Each project has its own variables, encrypted and injected at build and at service startup. Import them from a .env file, paste them directly, or add them one by one. Changing them triggers a new deployment.

FAQ

Does my private repository work?
Yes, Deplay connects to your GitHub account and clones the repository during the build.

What happens when I delete a project?
The web service's container is stopped and its public route removed within a minute.

Is storage shared?
Yes: 700 MB in total per account, across all sites and web services combined.