Orbit documentation

Getting started, supported operations and important limits.

Get started

Sign in to the web app, create or open a drive, and use the file browser. The Mac app and CLI releases are being prepared; see the download page for their status.

Web files

The browser supports uploads up to 3 GiB per file and downloads up to 512 MiB per file. Upload and download times depend on your connection. For larger files, use a supported S3 client or the Mac and CLI releases when available.

Search and offline

Search finds file and folder names in a selected drive with at least three characters and a connection. In the Mac app, Keep Offline downloads a drive to the local cache. Wait for completion before disconnecting, and allow enough disk space.

S3 access

Create access keys in the web app and configure your client for path-style requests to https://s3.orbitfs.io. For example, with an AWS CLI profile configured with your Orbit access key and secret:

aws configure set s3.addressing_style path --profile orbit
aws --profile orbit --endpoint-url https://s3.orbitfs.io \
  s3api list-objects-v2 --bucket YOUR_DRIVE_ALIAS

Orbit implements a subset of S3, including object reads, writes, listings, versions and multipart uploads. A single PUT is limited to 95 MB; use multipart for larger S3 uploads. Multi-range reads, object tagging, ACLs, lifecycle and several other operations are not supported. Check your client’s requirements before relying on an operation.

History and recovery

Restore available file versions from the app. Deleted data, retained history, staged data and data shared with forks can remain stored and may count toward quota. Deletion is not currently a guarantee of permanent erasure. Keep independent backups; contact support for recovery or deletion requests.

Support

Contact hi@orbitfs.io.