OrbitsDocs
esc
    Open Orbits
    Getting startedUpload a folder

    Deploy a folder without Git

    Deploy a project that has no repository by sending its folder as a zip. Orbits builds it like any other deployment and keeps the last five uploads for redeploys.

    Not every project lives in Git. An upload project has no repository: its source is a zip of a folder you send, and Orbits unpacks it in place of a Git clone, then detects the framework, installs, builds and serves it exactly as it would a repository. It works for any kind of project, not only static sites: a Vite app, a Next.js app or a Node server are built the same way.

    The quickest way to send a folder is the Orbits CLI.

    Deploy with the CLI

    Install the CLI and sign in once:

    Terminal
    $ curl -fsSL https://orbits.africa/install | bash$ orbits login

    orbits login opens the web app in your browser, where you choose the team and the access, and the CLI receives an API token for that team.

    Then, in your project's folder, make an upload project and deploy:

    Terminal
    $ cd my-site$ orbits link --create$ orbits deploy  ✓ Packed 14 files               48 KB  ✓ Uploaded                      48 KB  ✓ Queued                        1s  ✓ Installing                    6s  ✓ Building                      12s  ✓ Going live                    2s✓ Ready in 23s (production)https://my-site.theorbits.app

    orbits link --create makes a new upload project named after the folder and writes .orbits/project.json so later commands know which project the folder is (it also adds .orbits to .gitignore). orbits link without --create lets you pick an existing project instead.

    orbits deploy deploys the current folder; orbits deploy ./dist deploys another one. While it builds, the CLI shows each step and the build log. When it's ready it prints the address on standard output, so a script can capture it:

    Terminal
    $ url=$(orbits deploy --no-logs)

    Uploads always go to production. There is no preview for an upload.

    What goes in the zip

    Send the project's files: package.json, the source and its config, exactly as you would commit them. Orbits builds from source, so you don't need to build first (though a folder of plain HTML with an index.html is served as it is).

    These are left out, at any depth, whether the CLI packs the folder or you zip it yourself:

    • node_modules, .git, .next, __MACOSX and .DS_Store

    The CLI also leaves out .orbits, .env.local and .env.*.local, and anything matching the patterns in a .orbitsignore file in the folder (it uses .gitignore syntax).

    If the zip holds a single top-level folder, Orbits strips it, so zipping the folder or zipping its contents both work. Links and special files are refused.

    Limits

    Limit
    Zip size100 MiB (104,857,600 bytes)
    Unpacked size500 MiB
    Files and folders, unpacked20,000 entries (folders the zip lists count as well as files; what is left out doesn't count)
    Unfinished uploads per team5 at a time

    A zip over a limit fails on the Cloning repository step, with the reason in the build log.

    Redeploy and roll back

    Orbits keeps the archives of a project's last five uploads.

    • Redeploy rebuilds a deployment from its stored archive. A deployment older than the last five has no archive left, and Orbits says so: send the folder again.
    • Roll back points production at an earlier build without building anything, so it works whatever the archive's age, within the last three production builds.

    See deployments for both.

    Environment variables

    An upload project has environment variables like any other. Set them in the web app or with orbits env add, then deploy again: variables apply to deployments made after the change. See environment variables.

    In CI

    Make a token under Team › Settings › API tokens with full access, then:

    Terminal
    $ export ORBITS_TOKEN=orb_live_…$ orbits --project my-site deploy ./dist --no-logs

    A failed build exits with code 5, so the job fails with it.

    Through the API

    The CLI uses the public API, and so can you: start an upload, send the zip to the presigned URL it returns, then complete the upload, which queues the production deployment. The steps and fields are in the deployments API.

    Was this page helpful?

    Updated