Skip to content
This page View Markdown Open in ChatGPT Open in Claude

Deploy API Maker

  • Install another version of API Maker on every server of the cluster from the Deploy API Maker page of the admin panel.
  • This page upgrades API Maker itself. To deploy your APIs, use a Git pull. Learn more Git.
Deploy API Maker : admin panel → Caddy → API Maker → Redis → every server (5 stages, live progress) → restart, wait for the new version, reload Admin panel Deploy API Maker Deploy from NPM choose a version or Upload a bundle .tgz · .tar.gz · ≤ 100 MB A card per server · live log Caddy HTTPS · WSS reverse proxy :443 npm registry registry.npmjs.org downloads the version you chose (NPM only) API Maker Gets the bundle npm download or your upload Sends it out to one process of every server Redis one message to every server Every server API Maker runs under systemd 1 Write & extract 2 Clear old install 3 Copy new files 4 npm install 5 Env into admin panel Server 1 ✓ installed Server 2 npm install… Server 3 … N copying files… Stage 2 keeps .env · local.env · license.txt Each server at its own pace · 20 minutes at most live progress of every stage WebSocket · WSS through Caddy every server done the page takes over Restart all processes each one exits and API Maker starts it on the new files Wait for the version the page asks until every process answers on the new version Reload the page the admin panel opens on the new version A server fails or stays silent an error, or no answer within 20 minutes : nothing restarts · the page says why

Two ways

  • Deploy from NPM: pick a published version and click Deploy. It is downloaded from the official npm registry.
  • Upload a bundle: select a local API Maker .tgz or .tar.gz file, up to 100 MB.

What happens on each server

  1. The bundle is written to disk and extracted.
  2. The old install is cleared. .env, local.env and license.txt are kept.
  3. The new files are copied into place.
  4. Dependencies are installed.

  5. The environment is written into the bundled admin panel.

  6. The page shows a card per server and the live log of each stage.

  7. When every server has installed it, the page restarts all backend processes and waits until they answer on the new version.
  8. If a server reports an error or does not answer in time, the cluster is not restarted.

Good to know

  • A deployment waits up to 20 minutes for the servers to finish.
  • If the WebSocket connection of the page is down, the deployment keeps running and the page reports the result when it ends.