git.stevedylan.dev

chore: Updated orbiter deployment 42656e00

stevedylandev · 2025-06-24 16:53 3 file(s) · +59 −8

docs/pages/deployment/client/orbiter.mdx +1 −0

- Analytics
- Version Control for easy rollbacks
- GitHub actions for automated deployments
- Serverless Functions

In this guide we'll show you how to deploy your [`client`](/packages/client) to Orbiter in no time at all.


docs/pages/deployment/server/orbiter.mdx +54 −8

Orbiter Functions are only available on paid plans. [Upgrade today!](https://app.orbiter.host/billing)
::::

### Quickstart

If you haven't already created your bhvr app you can quickly create one using the Orbiter CLI

::::steps

### Setup Orbiter Account
#### Setup Orbiter Account

Visit [app.orbiter.host](https://app.orbiter.host) to create an account and make an API key on the [App Dashboard](https://app.orbiter.host) or on the [Keys Page](https://app.orbiter.host/api-keys).

### Install the Orbiter CLI and Authorize
#### Install the Orbiter CLI and Authorize

```bash [terminal]
bun add -g orbiter-cli@latest

orbiter auth
```

### Update Export Format
#### Create a New bhvr Project

Orbiter includes a special version of bhvr that has everything you need to have a fullstack app

```bash [terminal]
orbiter new --template bhvr
```

This will automatically install, build, and deploy the client and server packages of your bhvr project!

#### Deploy

Whenever you need to upload, simply run any of the `deploy` commands

```bash [terminal]
bun run deploy:client
bun run deploy:server
bun run deploy # Deploys both client and server
```

::::

### Manual Setup

Follow this guide if you already have an existing bhvr project you want to deploy to Orbiter

::::steps

#### Setup Orbiter Account

Visit [app.orbiter.host](https://app.orbiter.host) to create an account and make an API key on the [App Dashboard](https://app.orbiter.host) or on the [Keys Page](https://app.orbiter.host/api-keys).

#### Install the Orbiter CLI and Authorize

```bash [terminal]
bun add -g orbiter-cli@latest
```

```bash [terminal]
orbiter auth
```

#### Update Export Format

Update the code inside `server/src/index.ts` to use the export format required by Orbiter Functions:


}; // [!code ++]
```

### Deploy Server
#### Deploy Server

Move into the `server` package and run the deploy command with the server flag:


    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        

      - name: Setup Bun
        uses: oven-sh/setup-bun@v1
        with:
          bun-version: latest
        

      - name: Install dependencies
        run: bun install
        

      - name: Deploy to Orbiter
        env:
          ORBITER_API_KEY: ${{ secrets.ORBITER_API_KEY }}


For more information about how to use Orbiter Functions, visit the official docs:

<Button href="https://docs.orbiter.host/functions">Orbiter Functions Docs</Button>
<Button href="https://docs.orbiter.host/functions">Orbiter Functions Docs</Button>

vocs.config.tsx +4 −0

					collapsed: true,
					items: [
						{
							text: "Orbiter",
							link: "/deployment/server/orbiter",
						},
						{
							text: "Cloudflare Workers",
							link: "/deployment/server/cloudflare-workers",
						},

11	11		- Analytics
12	12		- Version Control for easy rollbacks
13	13		- GitHub actions for automated deployments
	14	+	- Serverless Functions
14	15
15	16		In this guide we'll show you how to deploy your [`client`](/packages/client) to Orbiter in no time at all.
16	17

21	21		Orbiter Functions are only available on paid plans. [Upgrade today!](https://app.orbiter.host/billing)
22	22		::::
23	23
	24	+	### Quickstart
	25	+
	26	+	If you haven't already created your bhvr app you can quickly create one using the Orbiter CLI
	27	+
24	28		::::steps
25	29
26		-	### Setup Orbiter Account
	30	+	#### Setup Orbiter Account
27	31
28	32		Visit [app.orbiter.host](https://app.orbiter.host) to create an account and make an API key on the [App Dashboard](https://app.orbiter.host) or on the [Keys Page](https://app.orbiter.host/api-keys).
29	33
30		-	### Install the Orbiter CLI and Authorize
	34	+	#### Install the Orbiter CLI and Authorize
31	35
32	36		```bash [terminal]
33	37		bun add -g orbiter-cli@latest

37	41		orbiter auth
38	42		```
39	43
40		-	### Update Export Format
	44	+	#### Create a New bhvr Project
	45	+
	46	+	Orbiter includes a special version of bhvr that has everything you need to have a fullstack app
	47	+
	48	+	```bash [terminal]
	49	+	orbiter new --template bhvr
	50	+	```
	51	+
	52	+	This will automatically install, build, and deploy the client and server packages of your bhvr project!
	53	+
	54	+	#### Deploy
	55	+
	56	+	Whenever you need to upload, simply run any of the `deploy` commands
	57	+
	58	+	```bash [terminal]
	59	+	bun run deploy:client
	60	+	bun run deploy:server
	61	+	bun run deploy # Deploys both client and server
	62	+	```
	63	+
	64	+	::::
	65	+
	66	+	### Manual Setup
	67	+
	68	+	Follow this guide if you already have an existing bhvr project you want to deploy to Orbiter
	69	+
	70	+	::::steps
	71	+
	72	+	#### Setup Orbiter Account
	73	+
	74	+	Visit [app.orbiter.host](https://app.orbiter.host) to create an account and make an API key on the [App Dashboard](https://app.orbiter.host) or on the [Keys Page](https://app.orbiter.host/api-keys).
	75	+
	76	+	#### Install the Orbiter CLI and Authorize
	77	+
	78	+	```bash [terminal]
	79	+	bun add -g orbiter-cli@latest
	80	+	```
	81	+
	82	+	```bash [terminal]
	83	+	orbiter auth
	84	+	```
	85	+
	86	+	#### Update Export Format
41	87
42	88		Update the code inside `server/src/index.ts` to use the export format required by Orbiter Functions:
43	89

72	118		}; // [!code ++]
73	119		```
74	120
75		-	### Deploy Server
	121	+	#### Deploy Server
76	122
77	123		Move into the `server` package and run the deploy command with the server flag:
78	124

133	179		steps:
134	180		- name: Checkout code
135	181		uses: actions/checkout@v4
136		-
	182	+
137	183		- name: Setup Bun
138	184		uses: oven-sh/setup-bun@v1
139	185		with:
140	186		bun-version: latest
141		-
	187	+
142	188		- name: Install dependencies
143	189		run: bun install
144		-
	190	+
145	191		- name: Deploy to Orbiter
146	192		env:
147	193		ORBITER_API_KEY: ${{ secrets.ORBITER_API_KEY }}

156	202
157	203		For more information about how to use Orbiter Functions, visit the official docs:
158	204
159		-	<Button href="https://docs.orbiter.host/functions">Orbiter Functions Docs</Button>
	205	+	<Button href="https://docs.orbiter.host/functions">Orbiter Functions Docs</Button>

116	116		collapsed: true,
117	117		items: [
118	118		{
	119	+	text: "Orbiter",
	120	+	link: "/deployment/server/orbiter",
	121	+	},
	122	+	{
119	123		text: "Cloudflare Workers",
120	124		link: "/deployment/server/cloudflare-workers",
121	125		},