Deploy API Maker

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.

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.