Orbiter is a website/web app hosting platform that is both open source and uses technologies that prevent vendor lock-in. To prove this, this tool allows you to "credibly exit" from Orbiter without needing to use any Orbiter APIs or requesting permission from Orbiter.
It will extract the most recent version of your site and download it to your computer.
To use this tool, you will need the following:
- Your site's smart contract address. To find and use this value, take these steps:
- Log into Orbiter, click the gear icon next to your site's name, then click the info button. You'll see a modal with the "Contract Address".
- In this tool's project folder, create a
.env.localfile and add:CONTRACT_ADDRESS=YOUR CONTRACT ADDRESS VALUE
- A Base RPC URL. You can get this from a few different free services:
Using the tool is as simple as following these steps:
- Install Bun by following this guide.
- Clone the repository:
git clone orbiter-probe - Change into the directory & install dependencies:
cd orbiter-probe && bun - Add a
.env.localfile with theCONTRACT_ADDRESSvalue as explained above and aRPC_URLvalue retrieved from the RPC provider you chose - Run
bun run index.ts
This will look through your site's contract events to find the most recent update to your site. It will then use a public IPFS gateway to fetch the directory of files and download it as a .tar file. You can then extract the .tar file and you will have the full site directory.